From 4fa495f6c042305cb156c4c8e94df3bbfb996ece Mon Sep 17 00:00:00 2001
From: Christine Kim <chkim@usgs.gov>
Date: Thu, 7 Sep 2023 11:24:03 -0700
Subject: [PATCH] Updated readme and added dep to env.yml

---
 README.md       | 23 +++++++++++++++++++++++
 environment.yml |  1 +
 2 files changed, 24 insertions(+)

diff --git a/README.md b/README.md
index f14115e..61bc9fd 100644
--- a/README.md
+++ b/README.md
@@ -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
diff --git a/environment.yml b/environment.yml
index 233b9cc..0af6ed8 100644
--- a/environment.yml
+++ b/environment.yml
@@ -18,3 +18,4 @@ dependencies:
   - pytest-cov 
   - coveralls 
   - nbsphinx
+  - sphinx=6.2.1
-- 
GitLab