624 B
624 B
platform docs
How to generate
pip install Sphinx
pip install sphinx_rtd_theme
If previous commands trigger Permission denied error try with sudo.
make html
How to contribute
Documentation uses Sphinx, an easy way to create structured documentation based on rst. Start with this tutorial
Why not markdown?
markdown is nice but rst has the same features, it's really similar but allow to have cross references. It also allow to use Sphinx which create TOC, generate different formats (pdf, epub) and allow to change themes.