Хостинг на Read The Docs

Read the Docs – сервис для хранения и публикации документации. На Read The Docs можно импортировать проект документации из сервисов: GitHub, Bitbucket and GitLab.

Чтобы импортировать проект из GitHub:

  1. Подготовьте проект:

    1. Убедитесь, что файлы проекта находятся в папке docs:

      _images/docs_folder.png

    2. В файл conf.py добавьте настройку:

      master_doc = 'index'

  2. Зарегистрируйтесь на сайте Read the Docs.

  3. Свяжите свой аккаунт GitHub с Read the Docs. Подробнее см. Connecting Your Account.

  4. Откройте раздел Мои проекты на Read the Docs.

    _images/my_projects.png

  5. Нажмите на кнопку Импортировать проект. Подробнее см. Importing Your Documentation.

  6. Выберите репозиторий с проектом.

  7. Проверьте детали проекта и нажмите на кнопку Вперед:

    _images/details.png

  8. Укажите дополнительные настройки и нажмите на кнопку Завершить:

    _images/extra.png

  9. Автоматически запустится сборка проекта:

    _images/building.png

При следующем изменении проекта в репозитории автоматически запустится сборка сайта на Read The Docs.

Примечание

Если в проекте используются расширения:

  1. Добавьте в папку docs файл requirements.txt и укажите в нем список зависимостей. Подробнее см. Requirements Files и Requirements File Format .
  2. На странице проекта нажмите на кнопку Админ и перейдите в Расширенные настройки.
  3. Укажите путь к файлу requirements.txt и нажмите на кнопку Сохранить:
_images/requirements.png

См.также

Работа с Read The Docs

GETTING STARTED