From e6f85e6f020e9478fe5428e738a2fbb9a42acf7e Mon Sep 17 00:00:00 2001 From: Peter Park Date: Wed, 31 Jul 2024 10:42:27 -0400 Subject: [PATCH] Docs: refactor and integrate into ROCm docs portal (#362) * pip-compile docs/requirements.txt Signed-off-by: Peter Jun Park Add Sphinx docs config Signed-off-by: Peter Jun Park Add Sphinx config Signed-off-by: Peter Jun Park Update docs build config Signed-off-by: Peter Jun Park * style(conf.py): Apply black formatting to docs/conf.py Signed-off-by: Sam Wu <22262939+samjwu@users.noreply.github.com> * Update docs requirements Signed-off-by: Peter Jun Park Update to rocm-docs-core 1.3.0 Signed-off-by: Peter Jun Park Update docs requirements Signed-off-by: Peter Jun Park pip-compile requirements Signed-off-by: Peter Jun Park bump rocm-docs-core to 1.5.0 bump rocm-docs-core to 1.4.1 Signed-off-by: Peter Jun Park * Add dependabot.yml and update CODEOWNERS Signed-off-by: Peter Jun Park Update toc and conf Signed-off-by: Peter Jun Park update dependabot * Port docs to rocm-docs standard Signed-off-by: Peter Jun Park Add toc and Diataxis cards Signed-off-by: Peter Jun Park Add basic file structure Signed-off-by: Peter Jun Park add glossary Signed-off-by: Peter Jun Park add includes Signed-off-by: Peter Jun Park Add license.rst Signed-off-by: Peter Jun Park add compatible hw Signed-off-by: Peter Jun Park fix spelling and license Signed-off-by: Peter Jun Park clean up index Signed-off-by: Peter Jun Park clean up installation guides Signed-off-by: Peter Jun Park add basic usage (quickstart) Signed-off-by: Peter Jun Park add ref to global options update toc Signed-off-by: Peter Jun Park modularize modes and global options Signed-off-by: Peter Jun Park add profile mode Signed-off-by: Peter Jun Park fixes Signed-off-by: Peter Jun Park reorg and clean up Signed-off-by: Peter Jun Park add dynamic omniperf version number in installation guide Signed-off-by: Peter Jun Park add datatemplate more reorg Signed-off-by: Peter Jun Park clean up Signed-off-by: Peter Jun Park reorg images move profile mode reorg reorg reorg more fix formatting fix headings ref anchor mi2xx note add extlinks add extlinks Signed-off-by: Peter Jun Park black format fix formatting, anchors Signed-off-by: Peter Jun Park reorg fix words and formatting Signed-off-by: Peter Jun Park formatting Signed-off-by: Peter Jun Park same reorg format fix formatting fix toc Signed-off-by: Peter Jun Park format * impr internal linking and fix sphinx warnings Signed-off-by: Peter Jun Park * add spellcheck/linting from rocm-docs-core Signed-off-by: Peter Jun Park fix rst directives satisfy spellcheck fix more spelling rm unused files fix spelling and update wordlist * bump rocm-docs-core to 1.6.0 Signed-off-by: Peter Jun Park * add fixes from @skyreflectedinmirrors and @lpaoletti Signed-off-by: Peter Jun Park add references to toc Signed-off-by: Peter Jun Park add more fixes Signed-off-by: Peter Jun Park * add package manager install section Signed-off-by: Peter Jun Park * add fixes Signed-off-by: Peter Jun Park add metadata and fixes Signed-off-by: Peter Jun Park add fixes bump to 1.6.1 more fixes fix fmt in profiling examples Signed-off-by: Peter Jun Park add missing mem type table Signed-off-by: Peter Jun Park fix formatting fmt * add custom css Signed-off-by: Peter Jun Park fix css fs * make images/figs click-to-expand Signed-off-by: Peter Jun Park add missed image update fix link * update documentation link in README Signed-off-by: Peter Jun Park * formatting fixes Signed-off-by: Peter Jun Park more formatting * fix heading Signed-off-by: Peter Jun Park * move archived docs Signed-off-by: Peter Jun Park * exclude archived docs from docs build Signed-off-by: Peter Jun Park * update archived docs workflow Signed-off-by: Peter Jun Park move files update archived docs workflow Signed-off-by: Peter Jun Park fix version number clean up workflow workflow test workflow test another workflow test * rm docs linting Signed-off-by: Peter Jun Park * Apply cmake-format suggested changes Signed-off-by: Sam Wu <22262939+samjwu@users.noreply.github.com> * Apply cmake-format Signed-off-by: Sam Wu <22262939+samjwu@users.noreply.github.com> --------- Signed-off-by: Peter Jun Park Signed-off-by: Sam Wu <22262939+samjwu@users.noreply.github.com> Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com> Signed-off-by: xuchen-amd --- .github/CODEOWNERS | 1 + .github/workflows/docs.yml | 7 ++----- docs/how-to/analyze/cli.rst | 2 +- 3 files changed, 4 insertions(+), 6 deletions(-) diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS index 3da13dc77..b5bfc317a 100644 --- a/.github/CODEOWNERS +++ b/.github/CODEOWNERS @@ -4,3 +4,4 @@ docs/ @ROCm/rocm-documentation *.md @ROCm/rocm-documentation *.rst @ROCm/rocm-documentation +.readthedocs.yaml @ROCm/rocm-documentation diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e61f66e98..d69867385 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -4,8 +4,6 @@ on: push: branches: [ amd-mainline ] paths: - - 'docs/archive/docs-2.x/**' - - 'docs/archive/docs-1.x/**' - 'docs/archive/docs-2.x/**' - 'docs/archive/docs-1.x/**' - '.github/workflows/docs.yml' @@ -38,16 +36,15 @@ jobs: - name: Build 1.x docs run: | cd docs/archive/docs-1.x - make html + cd docs/archive/docs-1.x + make html - name: Build 2.x docs run: | - cd docs/archive/docs-2.x cd docs/archive/docs-2.x make html - name: Relocate 1.x docs run: | mv docs/archive/docs-1.x/_build/html docs/archive/_build/html/1.x - mv docs/archive/docs-1.x/_build/html docs/archive/_build/html/1.x - name: Upload artifact uses: actions/upload-pages-artifact@v3 with: diff --git a/docs/how-to/analyze/cli.rst b/docs/how-to/analyze/cli.rst index 44a014a8b..f76e3970f 100644 --- a/docs/how-to/analyze/cli.rst +++ b/docs/how-to/analyze/cli.rst @@ -186,7 +186,7 @@ Walkthrough 3. Choose your own customized subset of metrics with the ``-b`` (or ``--block``) option. Or, build your own configuration following - `config_template `_. + `config_template `_. The following snippet shows how to generate a report containing only metric 2 (:doc:`System Speed-of-Light `).