Python文档

The Python language has a substantial body of documentation, much of it contributed by various authors. The markup used for the Python documentation is reStructuredText, developed by the docutils project, amended by custom directives and using a toolset named Sphinx to postprocess the HTML output.

This document describes the style guide for our documentation, the custom reStructuredText markup introduced to support Python documentation and how it should be used, as well as the Sphinx build system.

If you’re interested in contributing to Python’s documentation, there’s no need to write reStructuredText if you’re not so inclined; plain text contributions are more than welcome as well.

• Introduction

• Style Guide

• reStructuredText Primer
  • Paragraphs
  • Inline markup
  • Lists and Quotes
  • Source Code
  • Hyperlinks
    • External links
    • Internal links
  • Sections
  • Explicit Markup
  • Directives
  • Footnotes
  • Comments
  • Source encoding
  • Gotchas

• Additional Markup Constructs
  • File-wide metadata
  • Meta-information markup
  • Module-specific markup
  • Information units
  • Showing code examples
  • Inline markup
  • Cross-linking markup
  • Paragraph-level markup
  • Table-of-contents markup
  • Index-generating markup
  • Grammar production displays
  • Substitutions

• Differences to the LaTeX markup
  • Inline markup
  • Information units
  • Structure

• The Sphinx build system
  • The build configuration file