diff --git a/docs/.gitignore b/docs/.gitignore index 68d91289..b055dace 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -1,2 +1,5 @@ /_build /_doxygen +/_images +/_static +/_templates diff --git a/pyproject.toml b/pyproject.toml index 7561ea13..d6598234 100644 --- 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 index 2b3b7078..4630f75b 100644 --- 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/src/rocm_docs/rocm_docs_theme/static/images/amd-header-logo.svg b/src/rocm_docs/data/_images/amd-header-logo.svg similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/images/amd-header-logo.svg rename to src/rocm_docs/data/_images/amd-header-logo.svg diff --git a/src/rocm_docs/rocm_docs_theme/static/images/rdc-watermark.svg b/src/rocm_docs/data/_images/rdc-watermark.svg similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/images/rdc-watermark.svg rename to src/rocm_docs/data/_images/rdc-watermark.svg diff --git a/src/rocm_docs/rocm_docs_theme/static/images/rocm-logo.png b/src/rocm_docs/data/_images/rocm-logo.png similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/images/rocm-logo.png rename to src/rocm_docs/data/_images/rocm-logo.png diff --git a/src/rocm_docs/rocm_docs_theme/static/code_word_breaks.js b/src/rocm_docs/data/_static/code_word_breaks.js similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/code_word_breaks.js rename to src/rocm_docs/data/_static/code_word_breaks.js diff --git a/src/rocm_docs/rocm_docs_theme/static/custom.css b/src/rocm_docs/data/_static/custom.css similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/custom.css rename to src/rocm_docs/data/_static/custom.css diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts.css b/src/rocm_docs/data/_static/fonts.css similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts.css rename to src/rocm_docs/data/_static/fonts.css diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts.css.map b/src/rocm_docs/data/_static/fonts.css.map similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts.css.map rename to src/rocm_docs/data/_static/fonts.css.map diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts.scss b/src/rocm_docs/data/_static/fonts.scss similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts.scss rename to src/rocm_docs/data/_static/fonts.scss diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-300.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-300.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-300.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-300.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-300.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-300.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-300.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-300.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-300italic.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-300italic.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-300italic.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-300italic.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-300italic.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-300italic.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-300italic.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-300italic.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-500.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-500.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-500.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-500.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-500.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-500.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-500.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-500.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-500italic.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-500italic.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-500italic.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-500italic.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-500italic.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-500italic.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-500italic.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-500italic.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-600.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-600.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-600.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-600.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-600.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-600.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-600.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-600.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-600italic.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-600italic.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-600italic.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-600italic.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-600italic.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-600italic.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-600italic.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-600italic.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-700.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-700.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-700.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-700.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-700.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-700.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-700.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-700.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-700italic.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-700italic.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-700italic.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-700italic.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-700italic.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-700italic.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-700italic.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-700italic.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-800.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-800.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-800.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-800.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-800.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-800.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-800.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-800.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-800italic.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-800italic.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-800italic.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-800italic.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-800italic.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-800italic.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-800italic.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-800italic.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-300.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-300.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-300.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-300.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-300.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-300.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-300.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-300.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-300italic.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-300italic.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-300italic.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-300italic.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-300italic.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-300italic.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-300italic.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-300italic.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-500.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-500.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-500.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-500.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-500.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-500.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-500.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-500.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-500italic.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-500italic.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-500italic.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-500italic.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-500italic.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-500italic.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-500italic.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-500italic.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-600.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-600.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-600.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-600.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-600.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-600.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-600.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-600.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-600italic.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-600italic.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-600italic.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-600italic.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-600italic.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-600italic.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-600italic.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-600italic.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-700.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-700.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-700.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-700.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-700.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-700.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-700.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-700.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-700italic.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-700italic.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-700italic.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-700italic.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-700italic.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-700italic.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-700italic.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-700italic.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-800.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-800.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-800.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-800.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-800.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-800.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-800.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-800.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-800italic.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-800italic.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-800italic.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-800italic.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-800italic.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-800italic.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-800italic.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-800italic.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-italic.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-italic.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-italic.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-italic.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-italic.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-italic.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-italic.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-italic.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-regular.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-regular.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-regular.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-regular.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-regular.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-regular.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-ext-regular.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-ext-regular.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-italic.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-italic.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-italic.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-italic.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-italic.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-italic.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-italic.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-italic.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-regular.woff b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-regular.woff similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-regular.woff rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-regular.woff diff --git a/src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-regular.woff2 b/src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-regular.woff2 similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/fonts/open-sans/open-sans-v34-latin-regular.woff2 rename to src/rocm_docs/data/_static/fonts/open-sans/open-sans-v34-latin-regular.woff2 diff --git a/src/rocm_docs/rocm_docs_theme/static/rocm_footer.css b/src/rocm_docs/data/_static/rocm_footer.css similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/rocm_footer.css rename to src/rocm_docs/data/_static/rocm_footer.css diff --git a/src/rocm_docs/rocm_docs_theme/static/rocm_header.css b/src/rocm_docs/data/_static/rocm_header.css similarity index 100% rename from src/rocm_docs/rocm_docs_theme/static/rocm_header.css rename to src/rocm_docs/data/_static/rocm_header.css diff --git a/src/rocm_docs/rocm_docs_theme/components/copyright.html b/src/rocm_docs/data/_templates/components/copyright.html similarity index 100% rename from src/rocm_docs/rocm_docs_theme/components/copyright.html rename to src/rocm_docs/data/_templates/components/copyright.html diff --git a/src/rocm_docs/rocm_docs_theme/components/left-side-menu.html b/src/rocm_docs/data/_templates/components/left-side-menu.html similarity index 100% rename from src/rocm_docs/rocm_docs_theme/components/left-side-menu.html rename to src/rocm_docs/data/_templates/components/left-side-menu.html diff --git a/src/rocm_docs/rocm_docs_theme/components/social-links.html b/src/rocm_docs/data/_templates/components/social-links.html similarity index 100% rename from src/rocm_docs/rocm_docs_theme/components/social-links.html rename to src/rocm_docs/data/_templates/components/social-links.html diff --git a/src/rocm_docs/rocm_docs_theme/layout.html b/src/rocm_docs/data/_templates/layout.html similarity index 63% rename from src/rocm_docs/rocm_docs_theme/layout.html rename to src/rocm_docs/data/_templates/layout.html index 8c3b7fad..5966129d 100644 --- a/src/rocm_docs/rocm_docs_theme/layout.html +++ b/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/src/rocm_docs/rocm_docs_theme/sections/footer-content.html b/src/rocm_docs/data/_templates/sections/footer-content.html similarity index 100% rename from src/rocm_docs/rocm_docs_theme/sections/footer-content.html rename to src/rocm_docs/data/_templates/sections/footer-content.html diff --git a/src/rocm_docs/rocm_docs_theme/sections/footer.html b/src/rocm_docs/data/_templates/sections/footer.html similarity index 92% rename from src/rocm_docs/rocm_docs_theme/sections/footer.html rename to src/rocm_docs/data/_templates/sections/footer.html index db138c62..db8d3296 100644 --- a/src/rocm_docs/rocm_docs_theme/sections/footer.html +++ b/src/rocm_docs/data/_templates/sections/footer.html @@ -19,5 +19,5 @@
- DRAFT watermark + DRAFT watermark
diff --git a/src/rocm_docs/rocm_docs_theme/sections/header.html b/src/rocm_docs/data/_templates/sections/header.html similarity index 95% rename from src/rocm_docs/rocm_docs_theme/sections/header.html rename to src/rocm_docs/data/_templates/sections/header.html index 69022663..d2d0e8ff 100644 --- a/src/rocm_docs/rocm_docs_theme/sections/header.html +++ b/src/rocm_docs/data/_templates/sections/header.html @@ -1,7 +1,7 @@
- +
diff --git a/src/rocm_docs/rocm_docs_theme/theme.conf b/src/rocm_docs/rocm_docs_theme/theme.conf deleted file mode 100644 index 418e4cc3..00000000 --- a/src/rocm_docs/rocm_docs_theme/theme.conf +++ /dev/null @@ -1,5 +0,0 @@ -[theme] -inherit = sphinx_book_theme - -[options] -link_main_doc = True diff --git a/src/rocm_docs/theme.py b/src/rocm_docs/theme.py deleted file mode 100644 index 65ce9332..00000000 --- a/src/rocm_docs/theme.py +++ /dev/null @@ -1,42 +0,0 @@ -import sphinx -from sphinx.application import Sphinx -from sphinx.config import Config -from typing import Dict, Any -from pathlib import Path -from pydata_sphinx_theme import _get_theme_options -import rocm_docs.util as util - -def _update_theme_options(app: Sphinx) -> None: - url, branch, edit_page = util.get_branch(app.srcdir) - - options = _get_theme_options(app) - options.update({ - "home_page_in_toc": False, - "use_edit_page_button": edit_page, - "repository_url": url, - "repository_branch": branch, - "path_to_docs": util.get_path_to_docs(app.srcdir), - "show_navbar_depth": "0", - "body_max_width": "none", - "show_toc_level": "0", - "article_header_start": [ - "toggle-primary-sidebar.html", - "breadcrumbs.html", - ], - }) - if options.get("link_main_doc", True): - options["navbar_center"] = ["components/left-side-menu"] - -def setup(app: Sphinx) -> Dict[str, Any]: - app.add_js_file("code_word_breaks.js", loading_method="async") - here = Path(__file__).parent.resolve() - theme_path = here / "rocm_docs_theme" - app.add_html_theme("rocm_docs_theme", str(theme_path)) - for css in ["custom.css", "rocm_header.css", "rocm_footer.css", "fonts.css"]: - app.add_css_file(css) - app.connect("builder-inited", _update_theme_options) - - return { - "parallel_read_safe": True, - "parallel_write_safe": True, - }