Jonathan R. Madsen
496c95862b
* 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
[ROCm/rocprofiler-sdk commit: 729c34fb60]
20 lines
710 B
CMake
20 lines
710 B
CMake
if(NOT DEFINED SOURCE_DIR)
|
|
message(FATAL_ERROR "Please define SOURCE_DIR")
|
|
endif()
|
|
|
|
get_filename_component(SOURCE_DIR "${SOURCE_DIR}" ABSOLUTE)
|
|
|
|
find_program(DOT_EXECUTABLE NAMES dot)
|
|
|
|
if(NOT DOT_EXECUTABLE)
|
|
message(FATAL_ERROR "Please install dot and/or specify DOT_EXECUTABLE")
|
|
endif()
|
|
|
|
file(READ "${SOURCE_DIR}/VERSION" FULL_VERSION_STRING LIMIT_COUNT 1)
|
|
string(REGEX REPLACE "(\n|\r)" "" FULL_VERSION_STRING "${FULL_VERSION_STRING}")
|
|
string(REGEX REPLACE "([0-9]+)\\.([0-9]+)\\.([0-9]+)(.*)" "\\1.\\2.\\3"
|
|
ROCPROFILER_VERSION "${FULL_VERSION_STRING}")
|
|
|
|
configure_file(${SOURCE_DIR}/source/docs/rocprofiler.dox.in
|
|
${SOURCE_DIR}/source/docs/rocprofiler.dox @ONLY)
|