Files

T

Gopesh Bhardwaj 665c546e65 Documentation Updates (#470 )

* Updating installation doc

* updating README

* Addressing Yifan's feedback

* trivial updates

* Added limitation for individual xcc in readme

* Added rocprofv3 page

* README updates

* Updating rocprofv3

* source formatting (clang-format v11) (#538)

Co-authored-by: bgopesh <7112102+bgopesh@users.noreply.github.com>

* Merging documentation team's update

* Update source/docs/installation.md

Co-authored-by: Jonathan R. Madsen <jrmadsen@users.noreply.github.com>

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: bgopesh <7112102+bgopesh@users.noreply.github.com>
Co-authored-by: Jonathan R. Madsen <jrmadsen@users.noreply.github.com>

2024-03-07 21:05:16 -06:00

.gitignore

Support documentation build + install + packaging (#369 )

2024-01-14 08:10:14 -06:00

.nojekyll

Docs skeleton (#51 )

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

about.md

Improve static singleton memory safety (#316 )

2023-12-19 13:47:21 -06:00

buffered_services.md

Documentation Updates (#470 )

2024-03-07 21:05:16 -06:00

callback_services.md

Documentation Updates (#470 )

2024-03-07 21:05:16 -06:00

CMakeLists.txt

Fix DEB and RPM dependency spec + test building docs in CI (#426 )

2024-01-26 18:47:13 -06:00

conf.py

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

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

developer_api.md

Docs skeleton (#51 )

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

environment.yml

Docs skeleton (#51 )

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

features.md

Misc updates for distribution (#233 )

2023-11-28 10:04:37 -06:00

generate-doxyfile.cmake

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

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

index.md

Documentation Updates (#470 )

2024-03-07 21:05:16 -06:00

installation.md

Documentation Updates (#470 )

2024-03-07 21:05:16 -06:00

intercept_table.md

Misc updates for distribution (#233 )

2023-11-28 10:04:37 -06:00

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

requirements.txt

Counter API and Samples Updates (#410 )

2024-01-25 23:47:40 -06:00

rocprofiler-sdk.dox.in

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

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

rocprofv3.md

Documentation Updates (#470 )

2024-03-07 21:05:16 -06:00

samples.md

Documentation Updates (#470 )

2024-03-07 21:05:16 -06:00

tool_library_overview.md

Documentation Updates (#470 )

2024-03-07 21:05:16 -06: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.