Files

T

Baraldi, Giovanni 0ea9dbf7a8 Adding doc links for trace decoder, aqlprofile and viewer (#464 )

Adding interlinks for trace decoder, aqlprofile and viewer

Co-authored-by: Giovanni Baraldi <gbaraldi@amd.com>
Co-authored-by: Bhardwaj, Gopesh <Gopesh.Bhardwaj@amd.com>

[ROCm/rocprofiler-sdk commit: 9dadbbace5]

2025-06-18 14:10:18 +02:00

api-reference

Adding doc links for trace decoder, aqlprofile and viewer (#464 )

2025-06-18 14:10:18 +02:00

conceptual

[rocprofv3] Use -P for collection period shorthand option (#356 )

2025-04-27 20:18:26 -05:00

data

Adding rocpd documenation (#449 )

2025-06-17 15:41:53 +05:30

how-to

Adding doc links for trace decoder, aqlprofile and viewer (#464 )

2025-06-18 14:10:18 +02:00

install

Doc review (#386 )

2025-05-27 11:28:38 -05:00

sphinx

Updated source/docs/sphinx/requirements.txt (#310 )

2025-03-24 14:00:49 +05:30

_toc.yml.in

Adding rocpd documenation (#449 )

2025-06-17 15:41:53 +05:30

.gitignore

readthedocs updates (#877 )

2024-06-22 00:10:54 +05:30

.nojekyll

Docs skeleton (#51 )

2023-09-12 12:34:36 -05:00

CMakeLists.txt

[docs] Improve readability of ROCprofiler-SDK API library documentation (#359 )

2025-05-14 11:17:51 +05:30

conf.py

Making ROCTx API doxygen generated document more readable (#385 )

2025-05-22 18:08:55 -05:00

environment.yml

Using miniconda docker (#366 )

2025-04-23 23:52:03 -05:00

generate-doxyfile.cmake

ROCTx Documentation (#29 )

2025-01-22 11:34:21 -06:00

index.rst

Adding rocpd documenation (#449 )

2025-06-17 15:41:53 +05:30

license.rst

readthedocs updates (#877 )

2024-06-22 00:10:54 +05:30

Makefile

Docs skeleton (#51 )

2023-09-12 12:34:36 -05:00

README.md

Docs skeleton (#51 )

2023-09-12 12:34:36 -05:00

rocprofiler-sdk-roctx.dox.in

Making ROCTx API doxygen generated document more readable (#385 )

2025-05-22 18:08:55 -05:00

rocprofiler-sdk.dox.in

Making ROCTx API doxygen generated document more readable (#385 )

2025-05-22 18:08:55 -05:00

rocprofv3_input_schema.json

[rocprofv3] signal handler fix (#332 )

2025-04-17 21:10:52 -07:00

rocprofv3-schema.json

SWDEV-516846: Fix serialization services conflicts and ATT counter streaming (#230 )

2025-03-14 18:11:10 -07:00

README.md

ROCprofiler Documentation

Build Instructions

Install conda
- wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh
- bash miniconda.sh -b -p /opt/conda
- export PATH=${PATH}:/opt/conda
Install conda environment
- source activate
- conda env create -n rocprofiler-docs -f environment.yml
- conda activate rocprofiler-docs
Build the docs
- ../scripts/update-docs.sh
- HTML docs will be located in _build/html

Developer Information

If you create a new page, add the name of the new markdown file (without extension) to the index.md file.