Revert "Move theme settings to a custom sphinx theme (#41)"

This reverts commit 955105a.
ROCm · Mar 30, 2023 · 8a19ff1 · 8a19ff1
1 parent 955105a
commit 8a19ff1
Show file tree

Hide file tree

Showing 70 changed files with 46 additions and 56 deletions.
diff --git a/docs/.gitignore b/docs/.gitignore
@@ -1,2 +1,5 @@
 /_build
 /_doxygen
+/_images
+/_static
+/_templates
diff --git a/pyproject.toml b/pyproject.toml
@@ -30,6 +30,3 @@ requires-python = ">=3.8"
 api_reference = [
   "doxysphinx>=3.2.1,<4"
 ]
-
-[project.entry-points."sphinx.html_themes"]
-rocm_docs_theme = "rocm_docs.theme"
diff --git a/src/rocm_docs/__init__.py b/src/rocm_docs/__init__.py
@@ -43,10 +43,15 @@ class ROCmDocs:
         "external_toc_exclude_missing",
         "intersphinx_mapping",
         "intersphinx_disabled_domains",
+        "templates_path",
         "epub_show_urls",
         "exclude_patterns",
         "html_theme",
         "html_title",
+        "html_static_path",
+        "html_css_files",
+        "html_js_files",
+        "html_extra_path",
         "html_theme_options",
         "html_show_sphinx",
         "html_favicon",
@@ -75,7 +80,11 @@ def __init__(
         self.exclude_patterns: List[str]
         self.html_theme: str
         self.html_title: str
-        self.html_theme_options: Dict[str, Union[str, bool, List[str]]] = {}
+        self.html_static_path: List[str]
+        self.html_css_files: List[str]
+        self.html_js_files: List[str]
+        self.html_extra_path: List[str]
+        self.html_theme_options: Dict[str, Union[str, bool, List[str]]]
         self.html_show_sphinx: bool
         self.html_favicon: str
         self.numfig: bool
@@ -260,6 +269,7 @@ def setup(self) -> None:
                 " readable."
             )
         format_toc(self._docs_folder)
+        url, branch, edit_page = get_branch(self._docs_folder)
 
         self.external_toc_path = "./.sphinx/_toc.yml"
         self.external_toc_exclude_missing = False
@@ -272,6 +282,9 @@ def setup(self) -> None:
         }
         self.intersphinx_disabled_domains = ["std"]
 
+        # Other configuration
+        self.templates_path = ["_templates"]
+
         # -- Options foself.r EPUB output
         self.epub_show_urls = "footnote"
 
@@ -285,8 +298,32 @@ def setup(self) -> None:
         # The theme to use for HTML and HTML Help pages.  See the documentation
         # for a list of builtin themes.
         #
-        self.html_theme = "rocm_docs_theme"
+        self.html_theme = "sphinx_book_theme"
         self.html_title = self._project_name
+        self.html_static_path = ["_static"]
+        self.html_css_files = [
+            "custom.css",
+            "rocm_header.css",
+            "rocm_footer.css",
+            "fonts.css",
+        ]
+        self.html_js_files = ["code_word_breaks.js"]
+        self.html_extra_path = ["_images"]
+        self.html_theme_options = {
+            "home_page_in_toc": False,
+            "use_edit_page_button": edit_page,
+            "repository_url": url,
+            "repository_branch": branch,
+            "path_to_docs": get_path_to_docs(),
+            "show_navbar_depth": "0",
+            "body_max_width": "none",
+            "show_toc_level": "0",
+            "article_header_start": [
+                "toggle-primary-sidebar.html",
+                "breadcrumbs.html",
+            ],
+            "navbar_center": ["components/left-side-menu.html"],
+        }
 
         self.html_show_sphinx = False
         self.html_favicon = "https://www.amd.com/themes/custom/amd/favicon.ico"
@@ -296,7 +333,7 @@ def setup(self) -> None:
         self.copy_files()
 
     def disable_main_doc_link(self):
-        self.html_theme_options["link_main_doc"] = False
+        self.html_theme_options.pop("navbar_center")
 
     def copy_files(self):
         """Insert additional files into workspace."""

diff --git a/...s_theme/static/images/amd-header-logo.svg → ...ocm_docs/data/_images/amd-header-logo.svg b/...s_theme/static/images/amd-header-logo.svg → ...ocm_docs/data/_images/amd-header-logo.svg
diff --git a/...ocs_theme/static/images/rdc-watermark.svg → src/rocm_docs/data/_images/rdc-watermark.svg b/...ocs_theme/static/images/rdc-watermark.svg → src/rocm_docs/data/_images/rdc-watermark.svg
diff --git a/...cm_docs_theme/static/images/rocm-logo.png → src/rocm_docs/data/_images/rocm-logo.png b/...cm_docs_theme/static/images/rocm-logo.png → src/rocm_docs/data/_images/rocm-logo.png
diff --git a/...ocm_docs_theme/static/code_word_breaks.js → ...ocm_docs/data/_static/code_word_breaks.js b/...ocm_docs_theme/static/code_word_breaks.js → ...ocm_docs/data/_static/code_word_breaks.js
diff --git a/...cm_docs/rocm_docs_theme/static/custom.css → src/rocm_docs/data/_static/custom.css b/...cm_docs/rocm_docs_theme/static/custom.css → src/rocm_docs/data/_static/custom.css
diff --git a/...ocm_docs/rocm_docs_theme/static/fonts.css → src/rocm_docs/data/_static/fonts.css b/...ocm_docs/rocm_docs_theme/static/fonts.css → src/rocm_docs/data/_static/fonts.css
diff --git a/...docs/rocm_docs_theme/static/fonts.css.map → src/rocm_docs/data/_static/fonts.css.map b/...docs/rocm_docs_theme/static/fonts.css.map → src/rocm_docs/data/_static/fonts.css.map
diff --git a/...cm_docs/rocm_docs_theme/static/fonts.scss → src/rocm_docs/data/_static/fonts.scss b/...cm_docs/rocm_docs_theme/static/fonts.scss → src/rocm_docs/data/_static/fonts.scss
diff --git a/...ts/open-sans/open-sans-v34-latin-300.woff → ...ts/open-sans/open-sans-v34-latin-300.woff b/...ts/open-sans/open-sans-v34-latin-300.woff → ...ts/open-sans/open-sans-v34-latin-300.woff
diff --git a/...s/open-sans/open-sans-v34-latin-300.woff2 → ...s/open-sans/open-sans-v34-latin-300.woff2 b/...s/open-sans/open-sans-v34-latin-300.woff2 → ...s/open-sans/open-sans-v34-latin-300.woff2
diff --git a/...n-sans/open-sans-v34-latin-300italic.woff → ...n-sans/open-sans-v34-latin-300italic.woff b/...n-sans/open-sans-v34-latin-300italic.woff → ...n-sans/open-sans-v34-latin-300italic.woff
diff --git a/...-sans/open-sans-v34-latin-300italic.woff2 → ...-sans/open-sans-v34-latin-300italic.woff2 b/...-sans/open-sans-v34-latin-300italic.woff2 → ...-sans/open-sans-v34-latin-300italic.woff2
diff --git a/...ts/open-sans/open-sans-v34-latin-500.woff → ...ts/open-sans/open-sans-v34-latin-500.woff b/...ts/open-sans/open-sans-v34-latin-500.woff → ...ts/open-sans/open-sans-v34-latin-500.woff
diff --git a/...s/open-sans/open-sans-v34-latin-500.woff2 → ...s/open-sans/open-sans-v34-latin-500.woff2 b/...s/open-sans/open-sans-v34-latin-500.woff2 → ...s/open-sans/open-sans-v34-latin-500.woff2
diff --git a/...n-sans/open-sans-v34-latin-500italic.woff → ...n-sans/open-sans-v34-latin-500italic.woff b/...n-sans/open-sans-v34-latin-500italic.woff → ...n-sans/open-sans-v34-latin-500italic.woff
diff --git a/...-sans/open-sans-v34-latin-500italic.woff2 → ...-sans/open-sans-v34-latin-500italic.woff2 b/...-sans/open-sans-v34-latin-500italic.woff2 → ...-sans/open-sans-v34-latin-500italic.woff2
diff --git a/...ts/open-sans/open-sans-v34-latin-600.woff → ...ts/open-sans/open-sans-v34-latin-600.woff b/...ts/open-sans/open-sans-v34-latin-600.woff → ...ts/open-sans/open-sans-v34-latin-600.woff
diff --git a/...s/open-sans/open-sans-v34-latin-600.woff2 → ...s/open-sans/open-sans-v34-latin-600.woff2 b/...s/open-sans/open-sans-v34-latin-600.woff2 → ...s/open-sans/open-sans-v34-latin-600.woff2
diff --git a/...n-sans/open-sans-v34-latin-600italic.woff → ...n-sans/open-sans-v34-latin-600italic.woff b/...n-sans/open-sans-v34-latin-600italic.woff → ...n-sans/open-sans-v34-latin-600italic.woff
diff --git a/...-sans/open-sans-v34-latin-600italic.woff2 → ...-sans/open-sans-v34-latin-600italic.woff2 b/...-sans/open-sans-v34-latin-600italic.woff2 → ...-sans/open-sans-v34-latin-600italic.woff2
diff --git a/...ts/open-sans/open-sans-v34-latin-700.woff → ...ts/open-sans/open-sans-v34-latin-700.woff b/...ts/open-sans/open-sans-v34-latin-700.woff → ...ts/open-sans/open-sans-v34-latin-700.woff
diff --git a/...s/open-sans/open-sans-v34-latin-700.woff2 → ...s/open-sans/open-sans-v34-latin-700.woff2 b/...s/open-sans/open-sans-v34-latin-700.woff2 → ...s/open-sans/open-sans-v34-latin-700.woff2
diff --git a/...n-sans/open-sans-v34-latin-700italic.woff → ...n-sans/open-sans-v34-latin-700italic.woff b/...n-sans/open-sans-v34-latin-700italic.woff → ...n-sans/open-sans-v34-latin-700italic.woff
diff --git a/...-sans/open-sans-v34-latin-700italic.woff2 → ...-sans/open-sans-v34-latin-700italic.woff2 b/...-sans/open-sans-v34-latin-700italic.woff2 → ...-sans/open-sans-v34-latin-700italic.woff2
diff --git a/...ts/open-sans/open-sans-v34-latin-800.woff → ...ts/open-sans/open-sans-v34-latin-800.woff b/...ts/open-sans/open-sans-v34-latin-800.woff → ...ts/open-sans/open-sans-v34-latin-800.woff
diff --git a/...s/open-sans/open-sans-v34-latin-800.woff2 → ...s/open-sans/open-sans-v34-latin-800.woff2 b/...s/open-sans/open-sans-v34-latin-800.woff2 → ...s/open-sans/open-sans-v34-latin-800.woff2
diff --git a/...n-sans/open-sans-v34-latin-800italic.woff → ...n-sans/open-sans-v34-latin-800italic.woff b/...n-sans/open-sans-v34-latin-800italic.woff → ...n-sans/open-sans-v34-latin-800italic.woff
diff --git a/...-sans/open-sans-v34-latin-800italic.woff2 → ...-sans/open-sans-v34-latin-800italic.woff2 b/...-sans/open-sans-v34-latin-800italic.woff2 → ...-sans/open-sans-v34-latin-800italic.woff2
diff --git a/...pen-sans/open-sans-v34-latin-ext-300.woff → ...pen-sans/open-sans-v34-latin-ext-300.woff b/...pen-sans/open-sans-v34-latin-ext-300.woff → ...pen-sans/open-sans-v34-latin-ext-300.woff
diff --git a/...en-sans/open-sans-v34-latin-ext-300.woff2 → ...en-sans/open-sans-v34-latin-ext-300.woff2 b/...en-sans/open-sans-v34-latin-ext-300.woff2 → ...en-sans/open-sans-v34-latin-ext-300.woff2
diff --git a/...ns/open-sans-v34-latin-ext-300italic.woff → ...ns/open-sans-v34-latin-ext-300italic.woff b/...ns/open-sans-v34-latin-ext-300italic.woff → ...ns/open-sans-v34-latin-ext-300italic.woff
diff --git a/...s/open-sans-v34-latin-ext-300italic.woff2 → ...s/open-sans-v34-latin-ext-300italic.woff2 b/...s/open-sans-v34-latin-ext-300italic.woff2 → ...s/open-sans-v34-latin-ext-300italic.woff2
diff --git a/...pen-sans/open-sans-v34-latin-ext-500.woff → ...pen-sans/open-sans-v34-latin-ext-500.woff b/...pen-sans/open-sans-v34-latin-ext-500.woff → ...pen-sans/open-sans-v34-latin-ext-500.woff
diff --git a/...en-sans/open-sans-v34-latin-ext-500.woff2 → ...en-sans/open-sans-v34-latin-ext-500.woff2 b/...en-sans/open-sans-v34-latin-ext-500.woff2 → ...en-sans/open-sans-v34-latin-ext-500.woff2
diff --git a/...ns/open-sans-v34-latin-ext-500italic.woff → ...ns/open-sans-v34-latin-ext-500italic.woff b/...ns/open-sans-v34-latin-ext-500italic.woff → ...ns/open-sans-v34-latin-ext-500italic.woff
diff --git a/...s/open-sans-v34-latin-ext-500italic.woff2 → ...s/open-sans-v34-latin-ext-500italic.woff2 b/...s/open-sans-v34-latin-ext-500italic.woff2 → ...s/open-sans-v34-latin-ext-500italic.woff2
diff --git a/...pen-sans/open-sans-v34-latin-ext-600.woff → ...pen-sans/open-sans-v34-latin-ext-600.woff b/...pen-sans/open-sans-v34-latin-ext-600.woff → ...pen-sans/open-sans-v34-latin-ext-600.woff
diff --git a/...en-sans/open-sans-v34-latin-ext-600.woff2 → ...en-sans/open-sans-v34-latin-ext-600.woff2 b/...en-sans/open-sans-v34-latin-ext-600.woff2 → ...en-sans/open-sans-v34-latin-ext-600.woff2
diff --git a/...ns/open-sans-v34-latin-ext-600italic.woff → ...ns/open-sans-v34-latin-ext-600italic.woff b/...ns/open-sans-v34-latin-ext-600italic.woff → ...ns/open-sans-v34-latin-ext-600italic.woff
diff --git a/...s/open-sans-v34-latin-ext-600italic.woff2 → ...s/open-sans-v34-latin-ext-600italic.woff2 b/...s/open-sans-v34-latin-ext-600italic.woff2 → ...s/open-sans-v34-latin-ext-600italic.woff2
diff --git a/...pen-sans/open-sans-v34-latin-ext-700.woff → ...pen-sans/open-sans-v34-latin-ext-700.woff b/...pen-sans/open-sans-v34-latin-ext-700.woff → ...pen-sans/open-sans-v34-latin-ext-700.woff
diff --git a/...en-sans/open-sans-v34-latin-ext-700.woff2 → ...en-sans/open-sans-v34-latin-ext-700.woff2 b/...en-sans/open-sans-v34-latin-ext-700.woff2 → ...en-sans/open-sans-v34-latin-ext-700.woff2
diff --git a/...ns/open-sans-v34-latin-ext-700italic.woff → ...ns/open-sans-v34-latin-ext-700italic.woff b/...ns/open-sans-v34-latin-ext-700italic.woff → ...ns/open-sans-v34-latin-ext-700italic.woff
diff --git a/...s/open-sans-v34-latin-ext-700italic.woff2 → ...s/open-sans-v34-latin-ext-700italic.woff2 b/...s/open-sans-v34-latin-ext-700italic.woff2 → ...s/open-sans-v34-latin-ext-700italic.woff2
diff --git a/...pen-sans/open-sans-v34-latin-ext-800.woff → ...pen-sans/open-sans-v34-latin-ext-800.woff b/...pen-sans/open-sans-v34-latin-ext-800.woff → ...pen-sans/open-sans-v34-latin-ext-800.woff
diff --git a/...en-sans/open-sans-v34-latin-ext-800.woff2 → ...en-sans/open-sans-v34-latin-ext-800.woff2 b/...en-sans/open-sans-v34-latin-ext-800.woff2 → ...en-sans/open-sans-v34-latin-ext-800.woff2
diff --git a/...ns/open-sans-v34-latin-ext-800italic.woff → ...ns/open-sans-v34-latin-ext-800italic.woff b/...ns/open-sans-v34-latin-ext-800italic.woff → ...ns/open-sans-v34-latin-ext-800italic.woff
diff --git a/...s/open-sans-v34-latin-ext-800italic.woff2 → ...s/open-sans-v34-latin-ext-800italic.woff2 b/...s/open-sans-v34-latin-ext-800italic.woff2 → ...s/open-sans-v34-latin-ext-800italic.woff2
diff --git a/...-sans/open-sans-v34-latin-ext-italic.woff → ...-sans/open-sans-v34-latin-ext-italic.woff b/...-sans/open-sans-v34-latin-ext-italic.woff → ...-sans/open-sans-v34-latin-ext-italic.woff
diff --git a/...sans/open-sans-v34-latin-ext-italic.woff2 → ...sans/open-sans-v34-latin-ext-italic.woff2 b/...sans/open-sans-v34-latin-ext-italic.woff2 → ...sans/open-sans-v34-latin-ext-italic.woff2
diff --git a/...sans/open-sans-v34-latin-ext-regular.woff → ...sans/open-sans-v34-latin-ext-regular.woff b/...sans/open-sans-v34-latin-ext-regular.woff → ...sans/open-sans-v34-latin-ext-regular.woff
diff --git a/...ans/open-sans-v34-latin-ext-regular.woff2 → ...ans/open-sans-v34-latin-ext-regular.woff2 b/...ans/open-sans-v34-latin-ext-regular.woff2 → ...ans/open-sans-v34-latin-ext-regular.woff2
diff --git a/...open-sans/open-sans-v34-latin-italic.woff → ...open-sans/open-sans-v34-latin-italic.woff b/...open-sans/open-sans-v34-latin-italic.woff → ...open-sans/open-sans-v34-latin-italic.woff
diff --git a/...pen-sans/open-sans-v34-latin-italic.woff2 → ...pen-sans/open-sans-v34-latin-italic.woff2 b/...pen-sans/open-sans-v34-latin-italic.woff2 → ...pen-sans/open-sans-v34-latin-italic.woff2
diff --git a/...pen-sans/open-sans-v34-latin-regular.woff → ...pen-sans/open-sans-v34-latin-regular.woff b/...pen-sans/open-sans-v34-latin-regular.woff → ...pen-sans/open-sans-v34-latin-regular.woff
diff --git a/...en-sans/open-sans-v34-latin-regular.woff2 → ...en-sans/open-sans-v34-latin-regular.woff2 b/...en-sans/open-sans-v34-latin-regular.woff2 → ...en-sans/open-sans-v34-latin-regular.woff2
diff --git a/...cs/rocm_docs_theme/static/rocm_footer.css → src/rocm_docs/data/_static/rocm_footer.css b/...cs/rocm_docs_theme/static/rocm_footer.css → src/rocm_docs/data/_static/rocm_footer.css
diff --git a/...cs/rocm_docs_theme/static/rocm_header.css → src/rocm_docs/data/_static/rocm_header.css b/...cs/rocm_docs_theme/static/rocm_header.css → src/rocm_docs/data/_static/rocm_header.css
diff --git a/...rocm_docs_theme/components/copyright.html → ...data/_templates/components/copyright.html b/...rocm_docs_theme/components/copyright.html → ...data/_templates/components/copyright.html
diff --git a/...docs_theme/components/left-side-menu.html → ..._templates/components/left-side-menu.html b/...docs_theme/components/left-side-menu.html → ..._templates/components/left-side-menu.html
diff --git a/...m_docs_theme/components/social-links.html → ...a/_templates/components/social-links.html b/...m_docs_theme/components/social-links.html → ...a/_templates/components/social-links.html
diff --git a/src/rocm_docs/rocm_docs_theme/layout.html → src/rocm_docs/data/_templates/layout.html b/src/rocm_docs/rocm_docs_theme/layout.html → src/rocm_docs/data/_templates/layout.html
@@ -1,4 +1,4 @@
-{% extends "sphinx_book_theme/layout.html" %}
+{% extends "!layout.html" %}
 
 {%- block footer %}
     {%- include "sections/footer.html" %}

diff --git a/...m_docs_theme/sections/footer-content.html → ...a/_templates/sections/footer-content.html b/...m_docs_theme/sections/footer-content.html → ...a/_templates/sections/footer-content.html
diff --git a/...docs/rocm_docs_theme/sections/footer.html → ...docs/data/_templates/sections/footer.html b/...docs/rocm_docs_theme/sections/footer.html → ...docs/data/_templates/sections/footer.html
@@ -19,5 +19,5 @@
 </div>
 
 <div id="rdc-watermark-container">
-    <img id="rdc-watermark" src="{{ pathto('_static/images/rdc-watermark.svg',1) }}" alt="DRAFT watermark"/>
+    <img id="rdc-watermark" src="{{ pathto('rdc-watermark.svg',1) }}" alt="DRAFT watermark"/>
 </div>
diff --git a/...docs/rocm_docs_theme/sections/header.html → ...docs/data/_templates/sections/header.html b/...docs/rocm_docs_theme/sections/header.html → ...docs/data/_templates/sections/header.html
@@ -1,7 +1,7 @@
 <div class="rocm-header">
     <div class="rocm-header-buttons">
         <a href="https://www.amd.com" class="rocm-header-link">
-            <img id="amd-logo" alt="Advanced Micro Devices, Inc." src="{{ pathto('_static/images/rocm-logo.png',1) }}"></img>
+            <img id="amd-logo" alt="Advanced Micro Devices, Inc." src="{{ pathto('rocm-logo.png',1) }}"></img>
             <div class="glow-wrap">
                 <i class="glow"></i>
             </div>

diff --git a/src/rocm_docs/rocm_docs_theme/theme.conf b/src/rocm_docs/rocm_docs_theme/theme.conf
diff --git a/src/rocm_docs/theme.py b/src/rocm_docs/theme.py