Documenation

We use extended Markdown, as implemented by MkDocs, for documentation. The API docs are autogenerated using MarkdownAPIGenerator in md_autogen.py.

Dependencies

sudo pip install mkdocs
sudo pip install https://github.com/mitya57/python-markdown-math/archive/master.zip

Updating Documenation

Run ./update_docs.py [--live] . It will

• Copy README.md to templates/index.md
• Generate API docs for modules.
• mkdocs build without --live: build site to and start http server localhost:8000 to debug docs
• mkdocs gh-deploy with --live: deploy docs live on Github