ROCTx Documentation (#29)

* Add roctx doc

* Add roctx doxyfile input

* Update links and toc

* Build doxysphinx for both doxygen files

* Update scripts

* Generate roctx doxygen files

* Change doxygen path

to allow for 2 doxyfiles

* Make doxygen dir for script

* Call make _doxygen dir with p flag

* Create _doxygen dir in workfllow

* Create doc dirs for doxygen

* Run update docs as sudo

* Fix typo in mkdir command

* Include graphviz for dot

* Install dot for docs CI

* Install dot as sudo due to permission denied

* Install doxygen via sudo

* Install doxysphinx

* Add postcheckout step to RTD to config and gen doxygen docs

* On RTD, update doxygen after creating env

* update docs.yml

* update docs.yml

* fixing build-docs-from-source

* Fixing build docs from source

* update docs.yml

* trying to fix readthedocs

* trying to fix readthedocs

* update docs.yml

* improve mainpage documentation

* update docs

* clang-format fix

---------

Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com>
Co-authored-by: Madsen, Jonathan <Jonathan.Madsen@amd.com>
Este commit está contenido en:
Bhardwaj, Gopesh
2025-01-22 23:04:21 +05:30
cometido por GitHub
padre 73e72bb088
commit 73e7f8cfb1
Se han modificado 13 ficheros con 529 adiciones y 32 borrados
+20 -3
Ver fichero
@@ -48,7 +48,21 @@ jobs:
uses: actions/configure-pages@v5
- name: Create Docs Directory
run:
mkdir -p docs
mkdir -p docs/_doxygen/rocprofiler-sdk
mkdir -p docs/_doxygen/roctx
- name: Install Conda environment
shell: bash -el {0}
working-directory: source/docs
run: |
conda env create -n rocprofiler-docs -f environment.yml
- name: Install documentation dependencies
timeout-minutes: 10
shell: bash
run: |
sudo apt-get update
sudo apt-get install -y doxygen graphviz
sudo python3 -m pip install sphinx
sudo python3 -m pip install doxysphinx rocm-docs-core
- name: Build Docs
shell: bash -el {0}
working-directory: source/docs
@@ -59,7 +73,7 @@ jobs:
conda env create -n rocprofiler-docs -f environment.yml
source activate
conda activate rocprofiler-docs
../scripts/update-docs.sh
sudo ../scripts/update-docs.sh
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
@@ -88,7 +102,10 @@ jobs:
uses: actions/checkout@v4
with:
submodules: true
- name: Create Docs Directory
run:
mkdir -p source/docs/_doxygen/rocprofiler-sdk
mkdir -p source/docs/_doxygen/roctx
- name: Install requirements
timeout-minutes: 10
shell: bash