Skip to content
Snippets Groups Projects
Commit 4fa495f6 authored by Christine Kim's avatar Christine Kim
Browse files

Updated readme and added dep to env.yml

parent 30d83315
No related branches found
No related tags found
No related merge requests found
...@@ -64,3 +64,26 @@ To install the development version: ...@@ -64,3 +64,26 @@ To install the development version:
``` ```
conda install -c usgs-astrogeology/label/dev plio conda install -c usgs-astrogeology/label/dev plio
``` ```
Building documentation
======================
Create the `plio` conda environment:
```
conda env create -f environment.yml
```
Activate the conda environment:
```
conda activate plio
```
Go into the `docs` directory and build the sphinx docs with:
```
sphinx-build -b html . public
```
This outputs the generated documentation into `docs/public` where you can open `public/index.html` in a browser to view PLIO docs locally.
\ No newline at end of file
...@@ -18,3 +18,4 @@ dependencies: ...@@ -18,3 +18,4 @@ dependencies:
- pytest-cov - pytest-cov
- coveralls - coveralls
- nbsphinx - nbsphinx
- sphinx=6.2.1
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment