1
0
mirror of https://github.com/gryf/coach.git synced 2025-12-18 03:30:19 +01:00

update of api docstrings across coach and tutorials [WIP] (#91)

* updating the documentation website
* adding the built docs
* update of api docstrings across coach and tutorials 0-2
* added some missing api documentation
* New Sphinx based documentation
This commit is contained in:
Itai Caspi
2018-11-15 15:00:13 +02:00
committed by Gal Novik
parent 524f8436a2
commit 6d40ad1650
517 changed files with 71034 additions and 12834 deletions

31
docs_raw/README.md Normal file
View File

@@ -0,0 +1,31 @@
# 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.
To build the documentation website locally, first install the following requirements:
```
pip install Sphinx
pip install recommonmark
pip install sphinx_rtd_theme
pip install sphinx-autobuild
pip install sphinx-argparse
```
Then there are two option to build:
1. Build using the make file (recommended):
```
make html
cp source/_static/css/custom.css build/html/_static/css/
rm -rf ../docs/
mkdir ../docs
cp -R build/html/* ../docs/
```
2. Build automatically after every change while editing the files:
```
sphinx-autobuild source build/html
```