f70f369d46
* Initial doc update * addressed review comments * addressed review comments - 2 * accept reviewer suggestions Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * accept reviewer suggestions-2 Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * accept reviewer suggestions-3 Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * accept reviewer suggestions-4 Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Update README.md Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * Update CHANGELOG.md as per viewer suggestions Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * accept review suggestion Co-authored-by: Indic, Vladimir <Vladimir.Indic@amd.com> * accept reviewer suggestion Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> * accept reviewer suggestions Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> --------- Co-authored-by: Rawat, Swati <Swati.Rawat@amd.com> Co-authored-by: Indic, Vladimir <Vladimir.Indic@amd.com> Co-authored-by: Bhardwaj, Gopesh <Gopesh.Bhardwaj@amd.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.