documentation.rst

Documentation

.. index:: documentation;Python code, Restructured Text

Documenting Python

Use Restructured Text and PEP-257 for docstrings.

.. index:: documentation;projects, Sphinx docs

Documenting projects

Use Sphinx to document Python projects.

When doing that, follow the Restructured Text primer.

.. index:: documentation;projects, Read The Docs

ReadTheDocs

Read The Docs hosts documentation for applications and libraries written in Python.

The Getting Started walks through getting docs on the site.

You can also set up ReadTheDocs as a post-commit hook in GitHub.