Loading README.md +23 −0 Original line number Diff line number Diff line Loading @@ -64,3 +64,26 @@ To install the development version: ``` 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 environment.yml +1 −0 Original line number Diff line number Diff line Loading @@ -18,3 +18,4 @@ dependencies: - pytest-cov - coveralls - nbsphinx - sphinx=6.2.1 Loading
README.md +23 −0 Original line number Diff line number Diff line Loading @@ -64,3 +64,26 @@ To install the development version: ``` 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
environment.yml +1 −0 Original line number Diff line number Diff line Loading @@ -18,3 +18,4 @@ dependencies: - pytest-cov - coveralls - nbsphinx - sphinx=6.2.1
