> **Источник:** https://python-all.ru/3.0/documenting/index.html
>
> «Документация Python на русском» – неофициальный перевод официальной документации Python: версии от 2.6 до 3.16, полнотекстовый поиск, английский оригинал рядом с переводом. Эта Markdown-версия страницы предназначена для работы с LLM: вставьте её в ChatGPT, Claude или Cursor.

---

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

Язык Python имеет обширную документацию, значительная часть которой написана разными авторами. Разметка, используемая для документации Python, – это [reStructuredText](https://python-all.ru/3.0/documenting/index.html), разработанный проектом [docutils](https://python-all.ru/3.0/documenting/index.html), дополненный собственными директивами и использующий набор инструментов [Sphinx](https://python-all.ru/3.0/documenting/index.html) для постобработки HTML-вывода.

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

Если вы заинтересованы в участии в документации Python, вам не обязательно писать на reStructuredText, если вам это не подходит; обычный текст также приветствуется.

- [Введение](https://python-all.ru/3.0/documenting/intro.html)
- [Руководство по стилю](https://python-all.ru/3.0/documenting/style.html)
- [Введение в reStructuredText](https://python-all.ru/3.0/documenting/rest.html)

  - [Абзацы](https://python-all.ru/3.0/documenting/rest.html#paragraphs)
  - [Встроенная разметка](https://python-all.ru/3.0/documenting/rest.html#inline-markup)
  - [Списки и цитаты](https://python-all.ru/3.0/documenting/rest.html#lists-and-quotes)
  - [Исходный код](https://python-all.ru/3.0/documenting/rest.html#source-code)
  - [Гиперссылки](https://python-all.ru/3.0/documenting/rest.html#hyperlinks)

    - [Внешние ссылки](https://python-all.ru/3.0/documenting/rest.html#external-links)
    - [Внутренние ссылки](https://python-all.ru/3.0/documenting/rest.html#internal-links)
  - [Разделы](https://python-all.ru/3.0/documenting/rest.html#sections)
  - [Явная разметка](https://python-all.ru/3.0/documenting/rest.html#explicit-markup)
  - [Директивы](https://python-all.ru/3.0/documenting/rest.html#directives)
  - [Сноски](https://python-all.ru/3.0/documenting/rest.html#footnotes)
  - [Комментарии](https://python-all.ru/3.0/documenting/rest.html#comments)
  - [Кодировка исходного кода](https://python-all.ru/3.0/documenting/rest.html#source-encoding)
  - [Подводные камни](https://python-all.ru/3.0/documenting/rest.html#gotchas)
- [Дополнительные конструкции разметки](https://python-all.ru/3.0/documenting/markup.html)

  - [Разметка метаинформации](https://python-all.ru/3.0/documenting/markup.html#meta-information-markup)
  - [Разметка, специфичная для модулей](https://python-all.ru/3.0/documenting/markup.html#module-specific-markup)
  - [Информационные единицы](https://python-all.ru/3.0/documenting/markup.html#information-units)
  - [Примеры кода](https://python-all.ru/3.0/documenting/markup.html#showing-code-examples)
  - [Встроенная разметка](https://python-all.ru/3.0/documenting/markup.html#inline-markup)
  - [Разметка перекрёстных ссылок](https://python-all.ru/3.0/documenting/markup.html#cross-linking-markup)
  - [Разметка на уровне абзацев](https://python-all.ru/3.0/documenting/markup.html#paragraph-level-markup)
  - [Разметка оглавления](https://python-all.ru/3.0/documenting/markup.html#table-of-contents-markup)
  - [Разметка для создания указателя](https://python-all.ru/3.0/documenting/markup.html#index-generating-markup)
  - [Отображение грамматических правил](https://python-all.ru/3.0/documenting/markup.html#grammar-production-displays)
  - [Подстановки](https://python-all.ru/3.0/documenting/markup.html#substitutions)
- [Отличия от разметки LaTeX](https://python-all.ru/3.0/documenting/fromlatex.html)

  - [Встроенная разметка](https://python-all.ru/3.0/documenting/fromlatex.html#inline-markup)
  - [Информационные единицы](https://python-all.ru/3.0/documenting/fromlatex.html#information-units)
  - [Структура](https://python-all.ru/3.0/documenting/fromlatex.html#structure)