DocumentationΒΆ
Most documentation is written in reStructuredText but it is ok to use markdown as well. Markdown rendering uses recommonmark.
- Install pip: instructions
pip install -r requirements.txt
- Use entr to watch files, rebuild and run a webserver:
cd docs/ && find ./ | entr -d -r 'sphinx-build . docsbin/ && cd docsbin/ && python -SimpleHTTPServer
- or
cd docs/ && make watch