Files

T

Gopesh Bhardwaj 5c42d7d82a Getting Started docs for samples and tools (#261 )

* getting started for amples and tools

* Adding getting started to documentation

* Addressing review comments

* minor update

* renaming rocprofv2 to rocprofv3 in doc

* Apply suggestions from code review

---------

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

2023-12-04 16:22:18 -06:00

.gitignore

Docs skeleton (#51 )

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

.nojekyll

Docs skeleton (#51 )

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

about.md

Misc updates for distribution (#233 )

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

buffered_tracing.md

Misc updates for distribution (#233 )

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

callback_tracing.md

Misc updates for distribution (#233 )

2023-11-28 10:04:37 -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

getting_started.md

Getting Started docs for samples and tools (#261 )

2023-12-04 16:22:18 -06:00

index.md

Getting Started docs for samples and tools (#261 )

2023-12-04 16:22:18 -06:00

installation.md

Docs skeleton (#51 )

2023-09-12 12:34:36 -05: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

rocprofiler-sdk.dox

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

2023-11-29 20:43:18 -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

tool_library_overview.md

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

2023-11-29 20:43:18 -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.