Прочтите документацию Docs Hosts для сообщества открытого исходного кода. Он поддерживает множество инструментов документации (например, документы Sphinx, написанные с помощью reStructuredText, документы MkDocs, написанные с использованием уценки и т. д.), и может извлекать репозитории Git. Затем мы создаем документацию и размещаем ее для вас. Думайте об этом как о непрерывной документации или как о документации как о коде.
Полную документацию по настройке вашего проекта вы найдете на сайте Read the Docs.
Информацию о том, как связаться с Read the Docs, можно найти на нашей странице «Вклад».
Информацию о том, как внести свой вклад в чтение документов, можно найти на нашей странице «Вклад».
К концу этого краткого руководства у вас будет автоматически обновляться новый проект при отправке его на GitHub.
Создайте учетную запись на сайте Read the Docs, зарегистрировавшись на GitHub.
При появлении запроса на GitHub предоставьте доступ к своей учетной записи.
Авторизуйтесь и нажмите «Добавить проект».
Начните вводить имя вашего репозитория, выберите его из списка и нажмите «Продолжить».
При желании измените любую информацию и нажмите «Далее».
Все готово. Примите решение, и ваш проект автоматически обновится.
MIT © 2010 Read the Docs, Inc. и участники
