Jonathan R. Madsen
3769bb7dbf
* 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
ROCprofiler Documentation
Build Instructions
- Install conda
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.shbash miniconda.sh -b -p /opt/condaexport PATH=${PATH}:/opt/conda
- Install conda environment
source activateconda env create -n rocprofiler-docs -f environment.ymlconda 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.