aprakos-ts

Публикация в ReadTheDocs

  1. Для публикации материалов документации пройдите регистрацию на readthedocs.io с помощью аккаунта GitHub.
  1. Откройте свой редактор и добавьте в корень проекта файл mkdocs.yml с таким содержимым:
site_name: Name-project
site_url: https://youre.domain.zone/
theme: readthedocs
local: ru

проверте чтобы не было пробелов от начала строки (линии) и отступов сверху.

Опубликуйте материалы в github.

  1. Зайдите в аккаунт ReadTheDocs и подключите репозиторий с вашим файлом mkdocs.yml. Выполните сборку и просмотрите результат.

Более подробно можно ознакомится в документации на сайте docs.readthedocs.io.

img