文件

T

Gopesh Bhardwaj 785cc39c16 gobhardw/docs refactor (#975 )

* refactor docs

* Fixing docs build

* merging 967

* Improving readability with table usage

* review changes

* compilation fix

* README links

---------

Co-authored-by: srawat <120587655+SwRaw@users.noreply.github.com>

2024-07-18 12:58:20 +05:30

data

gobhardw/docs refactor (#975 )

2024-07-18 12:58:20 +05:30

how-to

gobhardw/docs refactor (#975 )

2024-07-18 12:58:20 +05:30

install

gobhardw/docs refactor (#975 )

2024-07-18 12:58:20 +05:30

sphinx

readthedocs updates (#877 )

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

_toc.yml.in

gobhardw/docs refactor (#975 )

2024-07-18 12:58:20 +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

buffered_services.md

readthedocs updates (#877 )

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

callback_services.md

readthedocs updates (#877 )

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

CMakeLists.txt

readthedocs updates (#877 )

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

conf.py

readthedocs updates (#877 )

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

counter_collection_services.md

Accumulation metrics support and update counter collection API to aqlprofile_v2 (#915 )

2024-07-01 21:56:41 -03:00

environment.yml

readthedocs updates (#877 )

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

generate-doxyfile.cmake

Use -sdk suffix and reset VERSION to 0.0.0 (#263 )

2023-11-29 20:43:18 -06:00

index.rst

gobhardw/docs refactor (#975 )

2024-07-18 12:58:20 +05:30

intercept_table.md

readthedocs updates (#877 )

2024-06-22 00:10:54 +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

pc_sampling.md

Update pc_sampling.md (#896 )

2024-05-30 00:42:09 -05:00

README.md

Docs skeleton (#51 )

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

rocprofiler-sdk.dox.in

readthedocs updates (#877 )

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

rocprofv3-schema.json

JSON schema + JSON node vs. Perfetto category consistency (#869 )

2024-05-22 20:36:27 -05:00

tool_library_overview.md

gobhardw/docs refactor (#975 )

2024-07-18 12:58:20 +05:30

what-is-rocprof-sdk.rst

gobhardw/docs refactor (#975 )

2024-07-18 12:58:20 +05:30

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.