-
Notifications
You must be signed in to change notification settings - Fork 165
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update building the docs instructions
- Loading branch information
Showing
1 changed file
with
28 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |