gryf/coach
1
0
Fork 0
mirror of https://github.com/gryf/coach.git synced 2025-12-18 19:50:17 +01:00
Code Issues Projects Releases Wiki Activity

Update docs_raw README.md (#138)

Browse Source 
* Update README.md
This commit is contained in:
Gal Leibovich
2018-12-03 15:39:17 +02:00
committed by Scott Leishman
parent 28e5b8b612
commit 3e281b467b
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs_raw/README.md
View File

@@ -1,7 +1,7 @@
# Coach Documentation # Coach Documentation
Coach uses Sphinx with a Read The Docs theme for its documentation website. 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: 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: 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 make html
cp source/_static/css/custom.css build/html/_static/css/ cp source/_static/css/custom.css build/html/_static/css/
rm -rf ../docs/ rm -rf ../docs/
mkdir ../docs mkdir ../docs
touch ../docs/.nojekyll
cp -R build/html/* ../docs/ cp -R build/html/* ../docs/
``` ```