Skip to content
This repository was archived by the owner on Jul 26, 2021. It is now read-only.

Files

Latest commit

b6907e6 · Sep 12, 2018

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Aug 27, 2017
Jul 30, 2018
Aug 27, 2017
Jul 30, 2018
Aug 1, 2018
Sep 12, 2018

README.md

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