Jonathan R. Madsen
729c34fb60
* 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
813 B
813 B
Installation
.. toctree::
:glob:
:maxdepth: 4
Quick Start (Latest Release, Binary Installer)
TODO: Installation quick start
Operating System
TODO: supported OSes
Identifying the Operating System
If you are unsure of the operating system and version, the /etc/os-release and /usr/lib/os-release files contain
operating system identification data for Linux systems.
$ cat /etc/os-release
NAME="Ubuntu"
VERSION="20.04.4 LTS (Focal Fossa)"
ID=ubuntu
...
VERSION_ID="20.04"
...
The relevent fields are ID and the VERSION_ID.
Installing ROCprofiler from source
Build Requirements
TODO: build reqs
Building ROCprofiler
TODO: cmake build
Testing ROCprofiler
TODO: ctest
Installing ROCprofiler
TODO: make install and/or cpack