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

Enabling Coach Documentation to be run even when environments are not installed (#326)

Browse Source
This commit is contained in:
anabwan
2019-05-27 10:46:07 +03:00
committed by Gal Leibovich
parent 2b7d536da4
commit 342b7184bc
157 changed files with 5167 additions and 7477 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs_raw/README.md
View File

@@ -3,7 +3,15 @@
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:
To build automatically, first go to 'docs_raw' directory; the following is installing all required packages, making html
copying all new docs into 'coach/docs/'
Run the following command (make sure the it's an executable file):
```
./build_docs.sh
```
To build manually the documentation website locally, first install the following requirements:
```
pip install Sphinx