Skip to content
This repository
branch: master
Fetching contributors…

Octocat-spinner-32-eaf2f5

Cannot retrieve contributors at this time

file 43 lines (25 sloc) 1.07 kb

Documentation

System Message: ERROR/3 (<string>, line 5)

Unknown directive type "index".

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

Documenting Python

Use Restructured Text and PEP-257 for docstrings.

System Message: ERROR/3 (<string>, line 16)

Unknown directive type "index".

.. index:: documentation;projects, Sphinx docs

Documenting projects

Use Sphinx to document Python projects.

When doing that, follow the Restructured Text primer.

System Message: ERROR/3 (<string>, line 29)

Unknown directive type "index".

.. 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.

Something went wrong with that request. Please try again.