mirror of
https://github.com/ROCm/ROCm.git
synced 2026-01-08 22:28:06 -05:00
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
This commit is contained in:
Sam Wu
2
.github/dependabot.yml
vendored
2
.github/dependabot.yml
vendored
@@ -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"
|
||||
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -14,3 +14,4 @@ _readthedocs/
|
||||
|
||||
# avoid duplicating contributing.md due to conf.py
|
||||
docs/contributing.md
|
||||
docs/release.md
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.)_
|
||||
|
||||
@@ -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
|
||||
|
||||
12
docs/conf.py
12
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)
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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`
|
||||
|
||||
:::
|
||||
|
||||
@@ -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/)
|
||||
|
||||
:::
|
||||
|
||||
@@ -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/)
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@@ -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/)
|
||||
|
||||
:::
|
||||
|
||||
|
||||
@@ -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
|
||||
Reference in New Issue
Block a user