mirror of
https://github.com/gryf/coach.git
synced 2025-12-17 19:20:19 +01:00
15 lines
428 B
Plaintext
15 lines
428 B
Plaintext
installation
|
|
=============
|
|
1. install mkdocs by following the instructions here -
|
|
http://www.mkdocs.org/#installation
|
|
2. install the math extension for mkdocs
|
|
sudo -E pip install python-markdown-math
|
|
3. install the material theme
|
|
sudo -E pip install mkdocs-material
|
|
|
|
to build the documentation website run:
|
|
- mkdocs build
|
|
- python fix_index.py
|
|
|
|
this will create a folder named site which contains the documentation website
|