py_docs

A walk-through of Python documentation tools, including:

1. Docutils and reStructuredText
2. Sphinx
3. ReadTheDocs

This is a pretty good video tutorial.

Setting up

Install the requirements:

$ pip install -r requirements.txt

Then set up the sphinx project:

$ sphinx-quickstart

This will step you through several options. You can mostly keep the defaults.

"live" html

Paste this into docs/Makefile: