Skip to content

Commit

Permalink
Merge pull request #268 from cal-adapt/docs-directions
Browse files Browse the repository at this point in the history
Update README.md for building docs
  • Loading branch information
nicolejkeeney authored Aug 11, 2023
2 parents 1fd1893 + e1e9f87 commit 905de5b
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ You'll only need to do steps 1 and 3 **once** to build the environment. Then, ju
1. If you haven't already, build the conda environment for this project: ``conda env create -f environment.yml``
2. Next, activate the conda environment for this project: ``conda activate climakitae-tests``
3. In the conda environment, install the following packages through pip: ``pip install sphinx-book-theme==0.3.3 sphinx-design==0.3.0``
4. Serialize RST to HTML and start a web server (locally): ``make serve-docs``
4. Serialize RST to HTML and start a web server (locally): ``make serve-docs`` **NOTE:** this needs to be run from the root `climakitae` directory, not `climakitae/docs`
5. To see the locally served docs: http://localhost:8000/
6. Push changes to the file `docs/climakitae.rst`

Expand Down

0 comments on commit 905de5b

Please sign in to comment.