Compare commits

...

4 Commits

Author SHA1 Message Date
Alex Xu
3389d01ccd add extension to conf.py 2024-10-16 15:58:36 -04:00
Alex Xu
3e4f196932 add sphinx-build-compatibility extension 2024-10-16 15:57:28 -04:00
Alex Xu
9e2b81edff remove indentation 2024-10-16 14:53:24 -04:00
Alex Xu
9d28329735 add a trigger for addon search 2024-10-16 14:48:11 -04:00
4 changed files with 17 additions and 1 deletions

View File

@@ -95,7 +95,7 @@ article_pages = [
external_toc_path = "./sphinx/_toc.yml"
extensions = ["rocm_docs", "sphinx_reredirects"]
extensions = ["sphinx_build_compatibility.extension", "rocm_docs", "sphinx_reredirects"]
external_projects_current_project = "rocm"
@@ -117,3 +117,8 @@ html_theme_options = {"link_main_doc": False}
redirects = {"reference/openmp/openmp": "../../about/compatibility/openmp.html"}
numfig = False
html_js_files = [
"readthedocs.js",
]

6
docs/readthedocs.js Normal file
View File

@@ -0,0 +1,6 @@
// Trigger the Read the Docs Addons Search modal when clicking on "Search docs" input from the topnav.
document.querySelector("[role='search'] input").addEventListener("focusin", () => {
const event = new CustomEvent("readthedocs-search-show");
document.dispatchEvent(event);
});

View File

@@ -1,2 +1,3 @@
rocm-docs-core==1.8.1
sphinx-reredirects
git+https://github.com/readthedocs/sphinx-build-compatibility#egg=sphinx-build-compatibility

View File

@@ -92,6 +92,7 @@ requests==2.32.3
# via
# pygithub
# sphinx
# sphinx-build-compatibility
rocm-docs-core==1.8.1
# via -r requirements.in
smmap==5.0.1
@@ -107,6 +108,7 @@ sphinx==7.3.7
# pydata-sphinx-theme
# rocm-docs-core
# sphinx-book-theme
# sphinx-build-compatibility
# sphinx-copybutton
# sphinx-design
# sphinx-external-toc
@@ -114,6 +116,8 @@ sphinx==7.3.7
# sphinx-reredirects
sphinx-book-theme==1.1.3
# via rocm-docs-core
sphinx-build-compatibility @ git+https://github.com/readthedocs/sphinx-build-compatibility
# via -r requirements.in
sphinx-copybutton==0.5.2
# via rocm-docs-core
sphinx-design==0.6.0