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

---

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

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

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

> **Примечание**
>
> Если вы заинтересованы в содействии документации Python, вам не обязательно писать на reStructuredText, если у вас нет такого желания; вклады в виде обычного текста также приветствуются. Отправьте электронное письмо на [docs@python.org](https://python-all.ru/3.1/documenting/index.html) или откройте вопрос в [*трекере*](https://python-all.ru/3.1/bugs.html#reporting-bugs).

- [1. Введение](https://python-all.ru/3.1/documenting/intro.html)
- [2. Руководство по стилю](https://python-all.ru/3.1/documenting/style.html)
- [3. Введение в reStructuredText](https://python-all.ru/3.1/documenting/rest.html)
- [4. Дополнительные конструкции разметки](https://python-all.ru/3.1/documenting/markup.html)
- [5. Отличия от разметки LaTeX](https://python-all.ru/3.1/documenting/fromlatex.html)
- [6. Сборка документации](https://python-all.ru/3.1/documenting/building.html)