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]>

.github/CODEOWNERS

@@ -4,3 +4,4 @@
 docs/ @ROCm/rocm-documentation
 *.md @ROCm/rocm-documentation
 *.rst @ROCm/rocm-documentation
+.readthedocs.yaml @ROCm/rocm-documentation

.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:

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 <https://github.com/ROCm/omniperf/blob/amd-mainline/src/rocprof_compute_soc/analysis_configs/panel_config_template.yaml>`_.
+   `config_template <https://github.com/ROCm/omniperf/blob/main/src/omniperf_analyze/configs/panel_config_template.yaml>`_.
    The following snippet shows how to generate a report containing only metric 2
    (:doc:`System Speed-of-Light </conceptual/system-speed-of-light>`).