Docs: refactor and integrate into ROCm docs portal (ROCm#362)

* pip-compile docs/requirements.txt Signed-off-by: Peter Jun Park <[email protected]> Add Sphinx docs config Signed-off-by: Peter Jun Park <[email protected]> Add Sphinx config Signed-off-by: Peter Jun Park <[email protected]> Update docs build config Signed-off-by: Peter Jun Park <[email protected]> * style(conf.py): Apply black formatting to docs/conf.py Signed-off-by: Sam Wu <[email protected]> * Update docs requirements Signed-off-by: Peter Jun Park <[email protected]> Update to rocm-docs-core 1.3.0 Signed-off-by: Peter Jun Park <[email protected]> Update docs requirements Signed-off-by: Peter Jun Park <[email protected]> pip-compile requirements Signed-off-by: Peter Jun Park <[email protected]> bump rocm-docs-core to 1.5.0 bump rocm-docs-core to 1.4.1 Signed-off-by: Peter Jun Park <[email protected]> * Add dependabot.yml and update CODEOWNERS Signed-off-by: Peter Jun Park <[email protected]> Update toc and conf Signed-off-by: Peter Jun Park <[email protected]> update dependabot * Port docs to rocm-docs standard Signed-off-by: Peter Jun Park <[email protected]> Add toc and Diataxis cards Signed-off-by: Peter Jun Park <[email protected]> Add basic file structure Signed-off-by: Peter Jun Park <[email protected]> add glossary Signed-off-by: Peter Jun Park <[email protected]> add includes Signed-off-by: Peter Jun Park <[email protected]> Add license.rst Signed-off-by: Peter Jun Park <[email protected]> add compatible hw Signed-off-by: Peter Jun Park <[email protected]> fix spelling and license Signed-off-by: Peter Jun Park <[email protected]> clean up index Signed-off-by: Peter Jun Park <[email protected]> clean up installation guides Signed-off-by: Peter Jun Park <[email protected]> add basic usage (quickstart) Signed-off-by: Peter Jun Park <[email protected]> add ref to global options update toc Signed-off-by: Peter Jun Park <[email protected]> modularize modes and global options Signed-off-by: Peter Jun Park <[email protected]> add profile mode Signed-off-by: Peter Jun Park <[email protected]> fixes Signed-off-by: Peter Jun Park <[email protected]> reorg and clean up Signed-off-by: Peter Jun Park <[email protected]> add dynamic omniperf version number in installation guide Signed-off-by: Peter Jun Park <[email protected]> add datatemplate more reorg Signed-off-by: Peter Jun Park <[email protected]> clean up Signed-off-by: Peter Jun Park <[email protected]> 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 <[email protected]> black format fix formatting, anchors Signed-off-by: Peter Jun Park <[email protected]> reorg fix words and formatting Signed-off-by: Peter Jun Park <[email protected]> formatting Signed-off-by: Peter Jun Park <[email protected]> same reorg format fix formatting fix toc Signed-off-by: Peter Jun Park <[email protected]> format * impr internal linking and fix sphinx warnings Signed-off-by: Peter Jun Park <[email protected]> * add spellcheck/linting from rocm-docs-core Signed-off-by: Peter Jun Park <[email protected]> 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 <[email protected]> * add fixes from @skyreflectedinmirrors and @lpaoletti Signed-off-by: Peter Jun Park <[email protected]> add references to toc Signed-off-by: Peter Jun Park <[email protected]> add more fixes Signed-off-by: Peter Jun Park <[email protected]> * add package manager install section Signed-off-by: Peter Jun Park <[email protected]> * add fixes Signed-off-by: Peter Jun Park <[email protected]> add metadata and fixes Signed-off-by: Peter Jun Park <[email protected]> add fixes bump to 1.6.1 more fixes fix fmt in profiling examples Signed-off-by: Peter Jun Park <[email protected]> add missing mem type table Signed-off-by: Peter Jun Park <[email protected]> fix formatting fmt * add custom css Signed-off-by: Peter Jun Park <[email protected]> fix css fs * make images/figs click-to-expand Signed-off-by: Peter Jun Park <[email protected]> add missed image update fix link * update documentation link in README Signed-off-by: Peter Jun Park <[email protected]> * formatting fixes Signed-off-by: Peter Jun Park <[email protected]> more formatting * fix heading Signed-off-by: Peter Jun Park <[email protected]> * move archived docs Signed-off-by: Peter Jun Park <[email protected]> * exclude archived docs from docs build Signed-off-by: Peter Jun Park <[email protected]> * update archived docs workflow Signed-off-by: Peter Jun Park <[email protected]> move files update archived docs workflow Signed-off-by: Peter Jun Park <[email protected]> fix version number clean up workflow workflow test workflow test another workflow test * rm docs linting Signed-off-by: Peter Jun Park <[email protected]> * Apply cmake-format suggested changes Signed-off-by: Sam Wu <[email protected]> * Apply cmake-format Signed-off-by: Sam Wu <[email protected]> --------- Signed-off-by: Peter Jun Park <[email protected]> Signed-off-by: Sam Wu <[email protected]> Co-authored-by: Sam Wu <[email protected]> Signed-off-by: xuchen-amd <[email protected]>
xuchen-amd · Oct 29, 2024 · 71ffa57 · 71ffa57
1 parent e5c389d
commit 71ffa57
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git 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
@@ -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'
@@ -41,13 +39,11 @@ jobs:
           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/README.md b/README.md
@@ -4,17 +4,29 @@
 [![Docs](https://github.com/ROCm/rocprofiler-compute/actions/workflows/docs.yml/badge.svg)](https://rocm.github.io/rocprofiler-compute/)
 [![DOI](https://zenodo.org/badge/561919887.svg)](https://zenodo.org/badge/latestdoi/561919887)
 
+<<<<<<< HEAD
 # ROCm Compute Profiler
 
 ## General
 
 ROCm Compute Profiler, formerly known as Omniperf, is a system performance profiling tool for machine
+=======
+# Omniperf
+
+## General
+
+Omniperf is a system performance profiling tool for machine
+>>>>>>> 38bff8bc (Docs: refactor and integrate into ROCm docs portal (#362))
 learning/HPC workloads running on AMD MI GPUs. The tool presently
 targets usage on MI100, MI200, and MI300 accelerators.
 
 * For more information on available features, installation steps, and
 workload profiling and analysis, please refer to the online
+<<<<<<< HEAD
 [documentation](https://rocm.docs.amd.com/projects/rocprofiler-compute/en/latest/).
+=======
+[documentation](https://rocm.docs.amd.com/projects/omniperf/en/latest/).
+>>>>>>> 38bff8bc (Docs: refactor and integrate into ROCm docs portal (#362))
 
 * ROCm Compute Profiler is an AMD open source research project and is not supported
 as part of the ROCm software stack. We welcome contributions and