From 161fe0658fcac9292a8b911ae0b514051b577e55 Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Tue, 28 Nov 2023 10:29:49 -0700 Subject: [PATCH] refactor: Rename list theme to rocm-api-tools-list --- src/rocm_docs/data/projects.yaml | 1 + .../rocm_docs_theme/flavors/list/left-side-menu.jinja | 3 --- .../flavors/rocm-api-tools-list/left-side-menu.jinja | 3 +++ src/rocm_docs/theme.py | 2 +- 4 files changed, 5 insertions(+), 4 deletions(-) delete mode 100644 src/rocm_docs/rocm_docs_theme/flavors/list/left-side-menu.jinja create mode 100644 src/rocm_docs/rocm_docs_theme/flavors/rocm-api-tools-list/left-side-menu.jinja diff --git a/src/rocm_docs/data/projects.yaml b/src/rocm_docs/data/projects.yaml index 4df26a77..3db25bd6 100644 --- a/src/rocm_docs/data/projects.yaml +++ b/src/rocm_docs/data/projects.yaml @@ -53,6 +53,7 @@ projects: development_branch: amd-master rocm: https://rocm.docs.amd.com/en/${version} rocm-docs-core: https://rocm.docs.amd.com/projects/rocm-docs-core/en/${version} + rocm-api-tools-list: https://rocm.docs.amd.com/en/${version}/reference/library-index.html rocm_smi_lib: target: https://rocm.docs.amd.com/projects/rocm_smi_lib/en/${version} development_branch: master diff --git a/src/rocm_docs/rocm_docs_theme/flavors/list/left-side-menu.jinja b/src/rocm_docs/rocm_docs_theme/flavors/list/left-side-menu.jinja deleted file mode 100644 index bf6bd1be..00000000 --- a/src/rocm_docs/rocm_docs_theme/flavors/list/left-side-menu.jinja +++ /dev/null @@ -1,3 +0,0 @@ -{% -set main_doc_link = ("ROCm API & tools list", projects['rocm-list'] + "/reference/library-index.html") -%} diff --git a/src/rocm_docs/rocm_docs_theme/flavors/rocm-api-tools-list/left-side-menu.jinja b/src/rocm_docs/rocm_docs_theme/flavors/rocm-api-tools-list/left-side-menu.jinja new file mode 100644 index 00000000..02eac37f --- /dev/null +++ b/src/rocm_docs/rocm_docs_theme/flavors/rocm-api-tools-list/left-side-menu.jinja @@ -0,0 +1,3 @@ +{% +set main_doc_link = ("ROCm API & tools list", projects['rocm-api-tools-list']) +%} diff --git a/src/rocm_docs/theme.py b/src/rocm_docs/theme.py index 895d3000..e3ddedce 100644 --- a/src/rocm_docs/theme.py +++ b/src/rocm_docs/theme.py @@ -62,7 +62,7 @@ def _update_theme_options(app: Sphinx) -> None: theme_opts = get_theme_options_dict(app) _update_repo_opts(app.srcdir, theme_opts) - supported_flavors = ["rocm", "local", "list"] + supported_flavors = ["rocm", "local", "rocm-api-tools-list"] flavor = theme_opts.get("flavor", "rocm") if flavor not in supported_flavors: logger.error(