Skip to content
Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
15 lines (11 sloc) 627 Bytes

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
You can’t perform that action at this time.