Граф коммитов

2 Коммитов

Автор SHA1 Сообщение Дата
Jonathan R. Madsen 3769bb7dbf Minor documentation workflow updates (#53)
* Document rocprofiler version defines

- write doxygen for preprocessor defines
- make ROCPROFILER_SOVERSION number similar to  ROCPROFILER_VERSION
- remove ROCPROFILER_COMPILER_STRING

* Update rocprofiler.dox.in

- reformatted
- include rocprofiler/version.h in doxygen
- tweaked dot settings, e.g. made dot SVGs non-interactive

* Update scripts/update-docs.sh

- configure with cmake ROCPROFILER_INTERNAL_BUILD_DOCS=ON which just generates version.h and exits

* Update CMakeLists.txt

- support ROCPROFILER_INTERNAL_BUILD_DOCS=ON option for generating version.h and exiting
2023-09-13 19:14:23 -05:00
Jonathan R. Madsen 729c34fb60 Docs skeleton (#51)
* Add doxygen-awesome-css submodule

* Basic documentation files

- conf.py: run by sphinx
- about.md: info about rocprofiler
- features.md: overview of features
- installation.md: build/test/install instructions
- index.md: sets up main page
- generate-doxyfile.cmake: generates rocprofiler.dox with rocprofiler-specific info
- environment.yml: conda environment
- Makefile: sphinx makefile
- README.md: build instructions
- rocprofiler.dox.in: doxygen template
- .gitignore: ignores generated files
- .nojekyll: prevents GitHub Pages from using Jekyll for deployment of pages

* Documentation scripts

- scripts for doing common sequences of commands for building docs
- update-docs.sh: builds the docs and installs the docs if /docs directory is present
- update-doxygen.sh: quick script for generating doxygen

* Workflow for docs

- step for building docs
- step for deploying docs

* Update doxygen comments in include/rocprofiler

- rocprofiler.h / rocprofiler_plugins.h
  - fixed non-existent global references in doxygen comments
  - fixed parameter names that were incorrect or not updated

* Update docs workflow

- only deploy docs when on main branch
2023-09-12 12:34:36 -05:00