Документирование Python¶Documenting Python
Язык Python имеет обширную документацию, значительная часть которой написана разными авторами. Разметка, используемая для документации Python, – это reStructuredText, разработанный проектом docutils, дополненный собственными директивами и использующий набор инструментов Sphinx для постобработки HTML-вывода.
В этом документе описывается руководство по стилю для документации, специальная разметка reStructuredText, созданная для поддержки документации Python, и то, как её следует использовать, а также система сборки Sphinx.
Если вы заинтересованы в участии в документации Python, вам не обязательно писать на reStructuredText, если вам это не подходит; обычный текст также приветствуется.
- ВведениеIntroduction
- Руководство по стилюStyle Guide
- Введение в reStructuredTextreStructuredText Primer
- Дополнительные конструкции разметкиAdditional Markup Constructs
- Разметка метаинформации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
- Отличия от разметки LaTeXDifferences to the LaTeX markup