This be the README.md file for setting up the SPHINX deployment.
- To compile the documents in a
dev
environment:
conda activate read_docs
cd docs/
make clean html
The html
file is located under docs/build/html
.
- To compile as a stable release:
Push to Github and view the docs on the webpage: https://readthedocs.org/profiles/BarryDigby/ <https://readthedocs.org/profiles/BarryDigby/>
_.