docs icon indicating copy to clipboard operation
docs copied to clipboard

documentation

Building the documentation

  1. Install Python 2.7

  2. Install Python setuptools (to get the easy_install script)

  3. Install Sphinx: easy_install -U Sphinx

  4. Build the docs: make.bat html

ReStructured Text

  • http://docutils.sourceforge.net/rst.html
    • http://docutils.sourceforge.net/docs/user/rst/quickstart.html
    • http://docutils.sourceforge.net/docs/user/rst/quickref.html
    • http://docutils.sourceforge.net/docs/user/rst/cheatsheet.txt
  • http://sphinx-doc.org/rest.html

Sphinx Markup Constructs

  • http://sphinx-doc.org/markup/index.html

Sphinx

  • http://sphinx-doc.org/
  • https://pypi.python.org/pypi/sphinx-autobuild