Skip to content

Commit

Permalink
Update building the docs instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
eharkins authored Oct 1, 2021
1 parent f6f9213 commit dbd40e4
Showing 1 changed file with 28 additions and 6 deletions.
34 changes: 28 additions & 6 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,31 @@
# Auspice 'Read The Docs' Documentation.

Very much a work-in-progress!

```
make clean
make html
open _build/html/index.html
```
## Building the docs

Build dependencies are managed with [Conda](https://conda.io).
Install them
into an isolated environment named `auspice-docs` with:

conda env create

Enter the environment with:

conda activate auspice-docs

You can now build the documentation with:

make html

which invokes Sphinx to build static HTML pages in `build/html/`.
You can view them by running:

open build/html/index.html

You can clean the build directory for a fresh start with:

make clean

Leave the environment with:

conda deactivate

0 comments on commit dbd40e4

Please sign in to comment.