From f953a9929872c5ffe4a627dd8894e4629f200d29 Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Wed, 17 May 2023 11:40:18 -0600 Subject: [PATCH] Update links to new docs and rename .sphinx dir to sphinx (#2141) * 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 --- .github/dependabot.yml | 2 +- .gitignore | 1 + .readthedocs.yaml | 4 ++-- .wordlist.txt | 16 ++++++++-------- CONTRIBUTING.md | 6 +++--- README.md | 4 ++-- docs/conf.py | 12 ++++-------- docs/how_to/tuning_guides/mi100.md | 19 ------------------- docs/how_to/tuning_guides/mi200.md | 16 ---------------- docs/index.md | 1 - docs/reference/all.md | 2 +- docs/reference/hip.md | 4 ++-- docs/reference/validation_tools.md | 4 ++-- docs/{.sphinx => sphinx}/_toc.yml.in | 0 docs/{.sphinx => sphinx}/requirements.in | 0 docs/{.sphinx => sphinx}/requirements.txt | 2 +- 16 files changed, 27 insertions(+), 66 deletions(-) rename docs/{.sphinx => sphinx}/_toc.yml.in (100%) rename docs/{.sphinx => sphinx}/requirements.in (100%) rename docs/{.sphinx => sphinx}/requirements.txt (98%) diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 9cdf2d670..276690bd4 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -6,7 +6,7 @@ version: 2 updates: - package-ecosystem: "pip" # See documentation for possible values - directory: "/docs/.sphinx" # Location of package manifests + directory: "/docs/sphinx" # Location of package manifests open-pull-requests-limit: 10 schedule: interval: "daily" diff --git a/.gitignore b/.gitignore index f04360471..7301c3180 100644 --- a/.gitignore +++ b/.gitignore @@ -14,3 +14,4 @@ _readthedocs/ # avoid duplicating contributing.md due to conf.py docs/contributing.md +docs/release.md diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 43a0890c9..3be33d1f2 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -6,9 +6,9 @@ version: 2 sphinx: configuration: docs/conf.py -formats: [htmlzip] +formats: [htmlzip, pdf, epub] python: version: "3.8" install: - - requirements: docs/.sphinx/requirements.txt + - requirements: docs/sphinx/requirements.txt diff --git a/.wordlist.txt b/.wordlist.txt index 983e50609..8d469d9e5 100644 --- a/.wordlist.txt +++ b/.wordlist.txt @@ -1,3 +1,5 @@ +# isv_deployment_win +ABI # gpu_aware_mpi DMA GDR @@ -13,17 +15,15 @@ PeerDirect RDMA UCX ib_core -# isv_deployment_win -ABI -# tuning_guides -BMC -DGEMM -HPCG -IOPM -HPL # linear algebra LAPACK MMA backends cuSOLVER cuSPARSE +# tuning_guides +BMC +DGEMM +HPCG +HPL +IOPM diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aa2a25079..3e7613e00 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -94,10 +94,10 @@ following commands from the project root: ```sh python3 -mvenv .venv # Windows -.venv/Scripts/python -m pip install -r docs/.sphinx/requirements.txt +.venv/Scripts/python -m pip install -r docs/sphinx/requirements.txt .venv/Scripts/python -m sphinx -T -E -b html -d _build/doctrees -D language=en docs _build/html # Linux -.venv/bin/python -m pip install -r docs/.sphinx/requirements.txt +.venv/bin/python -m pip install -r docs/sphinx/requirements.txt .venv/bin/python -m sphinx -T -E -b html -d _build/doctrees -D language=en docs _build/html ``` @@ -225,7 +225,7 @@ resulting website show up on a locally serving web server. 4. Configure Python virtual environment (venv) - From the Command Palette, run `Python: Create Environment` - - Select `venv` environment and the `docs/.sphinx/requriements.txt` file. + - Select `venv` environment and the `docs/sphinx/requirements.txt` file. _(Simply pressing enter while hovering over the file from the dropdown is insufficient, one has to select the radio button with the 'Space' key if using the keyboard.)_ diff --git a/README.md b/README.md index 9a15f9f91..b51080ead 100644 --- a/README.md +++ b/README.md @@ -37,9 +37,9 @@ ROCm release. ```bash cd docs -pip3 install -r .sphinx/requirements.txt +pip3 install -r sphinx/requirements.txt -python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . ../_readthedocs/html +python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html ``` ## Older ROCm™ Releases diff --git a/docs/conf.py b/docs/conf.py index 2fa2d1d74..7295fc348 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -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) diff --git a/docs/how_to/tuning_guides/mi100.md b/docs/how_to/tuning_guides/mi100.md index 3df717765..5f252cf91 100644 --- a/docs/how_to/tuning_guides/mi100.md +++ b/docs/how_to/tuning_guides/mi100.md @@ -83,97 +83,78 @@ available as listed in {numref}`mi100-bios`. - AMD CBS / NBIO Common Options - IOMMU - Disable - - - * - AMD CBS / NBIO Common Options - PCIe Ten Bit Tag Support - Enable - - - * - AMD CBS / NBIO Common Options - Preferred IO - Manual - - - * - AMD CBS / NBIO Common Options - Preferred IO Bus - "Use lspci to find pci device id" - - - * - AMD CBS / NBIO Common Options - Enhanced Preferred IO Mode - Enable - - - * - AMD CBS / NBIO Common Options / SMU Common Options - Determinism Control - Manual - - - * - AMD CBS / NBIO Common Options / SMU Common Options - Determinism Slider - Power - - - * - AMD CBS / NBIO Common Options / SMU Common Options - cTDP Control - Manual - - - * - AMD CBS / NBIO Common Options / SMU Common Options - cTDP - 240 - - - * - AMD CBS / NBIO Common Options / SMU Common Options - Package Power Limit Control - Manual - - - * - AMD CBS / NBIO Common Options / SMU Common Options - Package Power Limit - 240 - - - * - AMD CBS / NBIO Common Options / SMU Common Options - xGMI Link Width Control - Manual - - - * - AMD CBS / NBIO Common Options / SMU Common Options - xGMI Force Link Width - 2 - - - * - AMD CBS / NBIO Common Options / SMU Common Options - xGMI Force Link Width Control - Force - - - * - AMD CBS / NBIO Common Options / SMU Common Options - APBDIS - 1 - - - * - AMD CBS / NBIO Common Options / SMU Common Options - DF C-states - Auto - - - * - AMD CBS / NBIO Common Options / SMU Common Options - Fixed SOC P-state - P0 - - - * - AMD CBS / UMC Common Options / DDR4 Common Options - Enforce POR - Accept - - - * - AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR - Overclock - Enabled - - - * - AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR - Memory Clock Speed diff --git a/docs/how_to/tuning_guides/mi200.md b/docs/how_to/tuning_guides/mi200.md index 6d79e23ff..3a3479041 100644 --- a/docs/how_to/tuning_guides/mi200.md +++ b/docs/how_to/tuning_guides/mi200.md @@ -82,37 +82,30 @@ Table 2: Recommended settings for the system BIOS in a GIGABYTE platform. - AMD CBS / NBIO Common Options - IOMMU - Disable - - - * - AMD CBS / NBIO Common Options - PCIe Ten Bit Tag Support - Auto - - - * - AMD CBS / NBIO Common Options - Preferred IO - Bus - - - * - AMD CBS / NBIO Common Options - Preferred IO Bus - "Use lspci to find pci device id" - - - * - AMD CBS / NBIO Common Options - Enhanced Preferred IO Mode - Enable - - - * - AMD CBS / NBIO Common Options / SMU Common Options - Determinism Control - Manual - - - * - AMD CBS / NBIO Common Options / SMU Common Options - Determinism Slider - Power - - - * - AMD CBS / NBIO Common Options / SMU Common Options - cTDP Control @@ -122,7 +115,6 @@ Table 2: Recommended settings for the system BIOS in a GIGABYTE platform. - AMD CBS / NBIO Common Options / SMU Common Options - cTDP - 280 - - - * - AMD CBS / NBIO Common Options / SMU Common Options - Package Power Limit Control @@ -132,7 +124,6 @@ Table 2: Recommended settings for the system BIOS in a GIGABYTE platform. - AMD CBS / NBIO Common Options / SMU Common Options - Package Power Limit - 280 - - - * - AMD CBS / NBIO Common Options / SMU Common Options - xGMI Link Width Control @@ -142,37 +133,30 @@ Table 2: Recommended settings for the system BIOS in a GIGABYTE platform. - AMD CBS / NBIO Common Options / SMU Common Options - xGMI Force Link Width - 2 - - - * - AMD CBS / NBIO Common Options / SMU Common Options - xGMI Force Link Width Control - Force - - - * - AMD CBS / NBIO Common Options / SMU Common Options - APBDIS - 1 - - - * - AMD CBS / NBIO Common Options / SMU Common Options - DF C-states - Enabled - - - * - AMD CBS / NBIO Common Options / SMU Common Options - Fixed SOC P-state - P0 - - - * - AMD CBS / UMC Common Options / DDR4 Common Options - Enforce POR - Accept - - - * - AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR - Overclock - Enabled - - - * - AMD CBS / UMC Common Options / DDR4 Common Options / Enforce POR - Memory Clock Speed diff --git a/docs/index.md b/docs/index.md index b56f6fc98..8a3834f93 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,7 +17,6 @@ agile, flexible, rapid and secure manner. [more...](rocm) :::{dropdown} [Deploy ROCm](deploy) - {doc}`/deploy/linux/index` -- {doc}`/deploy/quick_start_windows` - {doc}`/deploy/docker` ::: diff --git a/docs/reference/all.md b/docs/reference/all.md index 9a981509e..151c89f70 100644 --- a/docs/reference/all.md +++ b/docs/reference/all.md @@ -80,7 +80,7 @@ Computer vision related projects. :::{grid-item-card} [Validation Tools](validation_tools) -- [ROCm Validation Suite](https://rocmdocs.amd.com/projects/RVS/en/latest/) +- [ROCm Validation Suite](https://rocm.docs.amd.com/projects/ROCmValidationSuite/en/latest/) - [TransferBench](https://rocmdocs.amd.com/projects/TransferBench/en/latest/) ::: diff --git a/docs/reference/hip.md b/docs/reference/hip.md index 64b27b200..7e9644705 100644 --- a/docs/reference/hip.md +++ b/docs/reference/hip.md @@ -22,11 +22,11 @@ The HIP Runtime is used to enable GPU acceleration for all HIP language based pr :::::{grid} 1 1 1 1 :gutter: 1 -:::{grid-item-card} [HIPify](https://rocmdocs.amd.com/projects/HIPIFY/en/develop/) +:::{grid-item-card} [HIPify](https://rocm.docs.amd.com/projects/HIPIFY/en/latest/) HIPify assists with porting applications from based on CUDA to the HIP Runtime. Supported CUDA APIs are documented here as well. -- [Reference Manual](https://rocmdocs.amd.com/projects/HIPIFY/en/develop/) +- [Reference Manual](https://rocm.docs.amd.com/projects/HIPIFY/en/latest/) ::: diff --git a/docs/reference/validation_tools.md b/docs/reference/validation_tools.md index 485379773..38b05accd 100644 --- a/docs/reference/validation_tools.md +++ b/docs/reference/validation_tools.md @@ -3,10 +3,10 @@ :::::{grid} 1 1 2 2 :gutter: 1 -:::{grid-item-card} [RVS](https://rocmdocs.amd.com/projects/RVS/en/latest/) +:::{grid-item-card} [RVS](https://rocm.docs.amd.com/projects/ROCmValidationSuite/en/latest/) The ROCm Validation Suite is a system administrator’s and cluster manager's tool for detecting and troubleshooting common problems affecting AMD GPU(s) running in a high-performance computing environment, enabled using the ROCm software stack on a compatible platform. -- [Documentation](https://rocmdocs.amd.com/projects/RVS/en/latest/) +- [Documentation](https://rocm.docs.amd.com/projects/ROCmValidationSuite/en/latest/) ::: diff --git a/docs/.sphinx/_toc.yml.in b/docs/sphinx/_toc.yml.in similarity index 100% rename from docs/.sphinx/_toc.yml.in rename to docs/sphinx/_toc.yml.in diff --git a/docs/.sphinx/requirements.in b/docs/sphinx/requirements.in similarity index 100% rename from docs/.sphinx/requirements.in rename to docs/sphinx/requirements.in diff --git a/docs/.sphinx/requirements.txt b/docs/sphinx/requirements.txt similarity index 98% rename from docs/.sphinx/requirements.txt rename to docs/sphinx/requirements.txt index b38b36cd7..8643c46e8 100644 --- a/docs/.sphinx/requirements.txt +++ b/docs/sphinx/requirements.txt @@ -2,7 +2,7 @@ # This file is autogenerated by pip-compile with Python 3.8 # by the following command: # -# pip-compile .sphinx/requirements.in +# pip-compile sphinx/requirements.in # accessible-pygments==0.0.3 # via pydata-sphinx-theme