Документирование Python¶Documenting Python

Язык Python имеет обширную документацию, значительная часть которой написана разными авторами. Разметка, используемая для документации Python, – это reStructuredText, разработанный проектом docutils, дополненный собственными директивами и использующий набор инструментов Sphinx для постобработки HTML-вывода.

В этом документе описывается руководство по стилю для документации, а также пользовательская разметка reStructuredText, введённая Sphinx для поддержки документации Python, и то, как её следует использовать.

• 1. ВведениеIntroduction
• 2. Руководство по стилюStyle Guide
• 3. Введение в reStructuredTextreStructuredText Primer
• 4. Дополнительные конструкции разметкиAdditional Markup Constructs
• 5. Отличия от разметки LaTeXDifferences to the LaTeX markup
• 6. Сборка документацииBuilding the documentation