The Python language has a substantial body of documentation, much of itcontributed by various authors. The markup used for the Python documentation isreStructuredText, developed by thedocutils project, amended by customdirectives and using a toolset namedSphinx to postprocess the HTML output.
This document describes the style guide for our documentation as well as thecustom reStructuredText markup introduced by Sphinx to support Pythondocumentation and how it should be used.
Note
If you’re interested in contributing to Python’s documentation, there’s noneed to write reStructuredText if you’re not so inclined; plain textcontributions are more than welcome as well. Send an e-mail todocs@python.org or open an issue on thetracker.
Enter search terms or a module, class or function name.
