diff --git a/docs_raw/README.md b/docs_raw/README.md index 068fdb8..c1c8195 100644 --- a/docs_raw/README.md +++ b/docs_raw/README.md @@ -1,7 +1,7 @@ # Coach Documentation Coach uses Sphinx with a Read The Docs theme for its documentation website. -The website is hosted on GitHub pages, and is automatically pulled from the repository through the built docs directory. +The website is hosted on GitHub Pages, and is automatically pulled from the repository through the built docs directory. To build the documentation website locally, first install the following requirements: @@ -14,13 +14,14 @@ pip install sphinx-argparse ``` Then there are two option to build: -1. Build using the make file (recommended): +1. Build using the make file (recommended). Run from within the `docs_raw` directory: ``` make html cp source/_static/css/custom.css build/html/_static/css/ rm -rf ../docs/ mkdir ../docs +touch ../docs/.nojekyll cp -R build/html/* ../docs/ ```