github/ROCm
1
1
Fork 0
mirror of https://github.com/ROCm/ROCm.git synced 2026-01-09 14:48:06 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update links to new docs and rename .sphinx dir to sphinx (#2141)

Browse Source 
* update links to new docs and rename .sphinx dir to sphinx

* fix spelling and formatting
add new words to wordlist
remove empty headers
remove version number for ROCm in conf.py

fix typos

* add more formats to rtd config
This commit is contained in:
Sam Wu
2023-05-17 11:40:18 -06:00
committed by GitHub
parent 4096b867d8
commit f953a99298
16 changed files with 27 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
docs/conf.py
View File

@@ -24,16 +24,14 @@ linkcheck_anchors_ignore = [
linkcheck_ignore = [
# site to be built
"https://rocmdocs.amd.com/projects/ROCmCC/en/latest/",
"https://rocmdocs.amd.com/projects/RVS/en/latest/",
"https://rocmdocs.amd.com/projects/amdsmi/en/latest/",
"https://rocmdocs.amd.com/projects/rdc/en/latest/",
"https://rocmdocs.amd.com/projects/rocmsmi/en/latest/",
"https://rocmdocs.amd.com/projects/roctracer/en/latest/",
"https://rocmdocs.amd.com/projects/MIGraphX/en/latest/",
"https://rocmdocs.amd.com/projects/rocprofiler/en/latest/",
"https://github.com/ROCm-Developer-Tools/HIP-VS/blob/master/README.md",
"https://rocmdocs.amd.com/projects/HIPIFY/en/develop/",
# correct links that linkcheck times out on
"https://github.com/ROCm-Developer-Tools/HIP-VS/blob/master/README.md",
r"https://www.amd.com/system/files/.*.pdf",
"https://www.amd.com/en/developer/aocc.html",
"https://www.amd.com/en/support/linux-drivers",
@@ -42,12 +40,9 @@ linkcheck_ignore = [
"http://cs231n.stanford.edu/"
]
html_output_directory = "../_readthedocs/html"
setting_all_article_info = True
all_article_info_os = ["linux", "windows"]
all_article_info_author = ""
all_article_info_date = "2023-05-05"
all_article_info_read_time = "5-10 min read"
# pages with specific settings
article_pages = [
@@ -86,9 +81,10 @@ article_pages = [
{"file":"understand/isv_deployment_win", "os":["windows"]},
]
docs_core = ROCmDocs("ROCm Docs 5.5.1")
external_toc_path = "./sphinx/_toc.yml"
docs_core = ROCmDocs("ROCm Documentation")
docs_core.setup()
docs_core.disable_main_doc_link()
for sphinx_var in ROCmDocs.SPHINX_VARS:
globals()[sphinx_var] = getattr(docs_core, sphinx_var)