Gopesh Bhardwaj
a60c4def00
* readthedocs updates * Adding License * correcting table of contents path * Move doc requirements to sphinx dir * Compile requirements.txt * Update path to reqs * Adding missing python module * changing sphinx version * changing docutils version * enabling sphinx extensions * trying sphinx-rtd-theme * Remove unused doc configs * Remove unused html theme options * Add files to toc * temp commit to test * updating environment.yml for CI build * Update doc requirements To include rocprofiler-sdk in projects.yaml * Set external_projects_current_project as rocprofiler-sdk * Exclude external projects * Fix warning for missing static path * updating conf.py * Removing reST syntax * Use rocm-docs-core doxygen integration * Remove RST syntax from Markdown files * Generate doxyfile post checkout on RTD * Use custom RTD env * Specify mambaforge * Put conda before post checkout cmd * Add doxyfile for RTD * Run cmake from conf.py * Update environment.yml * Use mambaforge * Fix path to environment.yml * Call build doxyfile * Add Developer API title to Doxyfile * Config version header * Fix typo in conf.py * Format fix for conf.py * Increasing timeout for build-docs-from-source * Remove README as mainpage for doxyfile * Fix formatting in conf.py --------- Co-authored-by: Sam Wu <22262939+samjwu@users.noreply.github.com>
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.