Files

T

Jonathan R. Madsen 9fde046078 JSON schema + JSON node vs. Perfetto category consistency (#869 )

* Fix schema differences b/t JSON and perfetto

- "kernel_dispatches" (JSON) vs. "kernel_dispatch" (Perfetto) -> "kernel_dispatch"
- "scratch_api" (JSON) -> "scratch_memory"

* Update include/rocprofiler-sdk/cxx/serialization.hpp

- remove unnecessary includes causing circular dependency

* rocprofv3 docs

- Output formats
- JSON schema

* Spelling fix

* Update schema descriptions

* Improve assert log in test_perfetto_data

[ROCm/rocprofiler-sdk commit: b4dc4f8e92]

2024-05-22 20:36:27 -05: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

Fixing Markdown and Docs (#759 )

2024-04-14 14:35:00 -05:00

installation.md

Fixing Markdown and Docs (#759 )

2024-04-14 14:35:00 -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

requirements.txt

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

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

rocprofiler-sdk.dox.in

README update (#730 )

2024-04-02 14:11:05 -05:00

rocprofv3-schema.json

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

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

rocprofv3.md

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

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

samples.md

Documentation Updates (#470 )

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

tool_library_overview.md

Public C++ header files and samples updates (#819 )

2024-04-25 20:09:11 -05: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.