gryf/coach
1
0 Fork 0
mirror of https://github.com/gryf/coach.git synced 2026-10-13 10:02:30 +02: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 authored and Scott Leishman committed 2018-12-03 05:39:17 -08:00
1 parent 28e5b8b612
commit 3e281b467b
1 file changed
+3 -2
Download Patch File Download Diff File Expand all files Collapse all files
docs_raw/README.md
+3 -2
View File
@@ -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/
```