Documenting a Python project

This guide is intended to provide information on how to create technical documentation for a Python project using Sphinx. However, Sphinx can be used to build documents beyond Python projects.

Some considerations taken from the developer guide:

• More documentation is not necessarily better documentation.

• Use a tone respectful of the reader’s intelligence. Don’t talk down to them or waste their time.

Contents:

• Before starting
  • General view
  • Placing documentation in the project
• Getting started
  • Starting Sphinx
  • The setup
• reST and Sphinx markup constructs
  • Sectioning
  • Inline markup
  • Comments
  • Blocks
  • Lists
  • Tables
  • Cross references
  • Other reST directives
  • Other Sphinx directives
  • Math
  • Showing code
• Documenting your project
  • More docs
  • API documentation
• Extras
  • Docstrings
  • Cross referencing Python objects
  • Config
  • IPython
  • Documentation in Read the Docs
  • Themes
• Sphinx in short
• MyST
  • Introduction
  • Syntax

Tutorial

Follow the tutorial for Sphinx.

• Sphinx tutorial

Further resources:

• WriteTheDocs documentation guide

Indices and tables

• Index

• Module Index

• Search Page