Add 'projects/rocprofiler-sdk/' from commit 'bf0fad1d5406fbc51403ba1aa9621a9d4a9bce2b'
git-subtree-dir: projects/rocprofiler-sdk git-subtree-mainline:50a90550e9git-subtree-split:bf0fad1d54
This commit is contained in:
@@ -0,0 +1,19 @@
|
||||
# ROCprofiler Documentation
|
||||
|
||||
## Build Instructions
|
||||
|
||||
1. Install conda
|
||||
- `wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh -O miniconda.sh`
|
||||
- `bash miniconda.sh -b -p /opt/conda`
|
||||
- `export PATH=${PATH}:/opt/conda`
|
||||
2. Install conda environment
|
||||
- `source activate`
|
||||
- `conda env create -n rocprofiler-docs -f environment.yml`
|
||||
- `conda activate rocprofiler-docs`
|
||||
3. 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](index.md) file.
|
||||
Reference in New Issue
Block a user