readthedocs/readthedocs.org

Что это?

Ключевые возможности

• 01Получает исходные файлы документации напрямую из Git-репозиториев.
• 02Автоматически собирает проекты Sphinx и MkDocs после каждого push.
• 03Поддерживает и публикует несколько версий документации.
• 04Размещает собранную документацию на общедоступном или закрытом сайте.

Сценарии использования

• Размещение общедоступной документации по API или библиотеке проекта с открытым исходным кодом.
• Публикация внутренней документации команды, которая обновляется с каждым коммитом.
• Публикация документации с версиями, чтобы пользователи могли читать материалы для установленного ими релиза.

Быстрый старт

1. 1

   Зарегистрируйтесь на Read the Docs с помощью аккаунта GitHub

2. 2

   Когда GitHub предложит, предоставьте доступ к своим репозиториям

3. 3

   Войдите в аккаунт, нажмите «Добавить проект», выберите репозиторий и нажмите «Продолжить»

4. 4

   Проверьте сведения о проекте, нажмите «Далее» и отправьте коммиты, чтобы документация обновлялась автоматически

Что важно знать

• !Хостинговый сервис предназначен для проектов с документацией, а самостоятельное размещение всей платформы потребует значительных усилий.
• !Кодовая база представляет собой крупное Django-приложение со множеством зависимостей, поэтому настройка локальной среды разработки требует немало времени.

В подборках

Темы

Частые вопросы

Что такое readthedocs.org?

Платформа с открытым исходным кодом для автоматической сборки, версионирования и размещения документации из Git-репозиториев с поддержкой Sphinx и MkDocs. Read the Docs размещает документацию проектов с открытым исходным кодом и команд. Платформа получает её из Git-репозиториев, собирает с помощью таких инструментов, как Sphinx (reStructuredText) и MkDocs (Markdown), а затем публикует на хостинге.

readthedocs.org можно использовать бесплатно? Какая у него лицензия?

readthedocs.org распространяется с открытым исходным кодом под лицензией MIT. Перед использованием в коммерческих продуктах проверьте условия лицензии.

readthedocs.org всё ещё поддерживается?

Активно поддерживается. Последний коммит в readthedocs.org — 6 нояб. 2026 г..

Для чего можно использовать readthedocs.org?

Размещение общедоступной документации по API или библиотеке проекта с открытым исходным кодом. Публикация внутренней документации команды, которая обновляется с каждым коммитом. Публикация документации с версиями, чтобы пользователи могли читать материалы для установленного ими релиза.

Как установить readthedocs.org?

Зарегистрируйтесь на Read the Docs с помощью аккаунта GitHub Когда GitHub предложит, предоставьте доступ к своим репозиториям Войдите в аккаунт, нажмите «Добавить проект», выберите репозиторий и нажмите «Продолжить» Проверьте сведения о проекте, нажмите «Далее» и отправьте коммиты, чтобы документация обновлялась автоматически

Где скачать readthedocs.org?

Исходный код и инструкции по установке — на GitHub: https://github.com/readthedocs/readthedocs.org