Sphinx

Документация Sphinx находится в каталоге sphinx-doc. Пока генерация только в HTML и без докстрингов.

Для того, чтобы ее посмотреть вам потребуется поставить Sphinx (например, через pip)

pip install Sphinx

После этого у вас в каталоге системных скриптов

• /usr/local/bin/ под Unix
• C://PythonXY/Scripts/ под Windows
• где-то в другом месте, если вы, например, используете virtualenv, как я

должны появиться исполняемые файлы sphinx-build, sphinx-autogen, sphinx-apidoc и sphinx-quickstart, а также куча всего для docutils и Pygments, так как Sphinx тянет их как зависимости. Если вы еще не сделали этого раньше добавьте каталог со скриптами в переменную окружения PATH (актуально для Windows). В случае с virtualenv перед выполнением следующего шага используйте activate.

Теперь в каталоге /sphinx-doc/ запустите

make html

(для Windows там лежит make.bat так что поступаете точно так же). После этого в /spinx-doc/_build появляется куча сгенеренных html страниц. Открываете index.html. Сейчас документация выглядит аналогично документации Питона (2.6 - 3.1), но стили можно изменить.

UPDATE: Или... вы можете просто открыть index.rst прямо на гитхаб.

Синтаксис reStructuredText:

• Полная спецификация
• Справка поменьше