From dbd40e48d661024a6e06c96fd6904ac8e357efbd Mon Sep 17 00:00:00 2001 From: Elias Harkins Date: Fri, 1 Oct 2021 15:51:42 -0700 Subject: [PATCH] Update building the docs instructions --- docs/README.md | 34 ++++++++++++++++++++++++++++------ 1 file changed, 28 insertions(+), 6 deletions(-) diff --git a/docs/README.md b/docs/README.md index 9bf8135a9..56398aaa4 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,9 +1,31 @@ # Auspice 'Read The Docs' Documentation. -Very much a work-in-progress! -``` -make clean -make html -open _build/html/index.html -``` \ No newline at end of file +## 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