Версии тегов документации (Sphinx) - PullRequest
0 голосов
/ 04 июля 2019

Я использую Sphinx для создания документации для моего проекта.Как создать несколько версий на основе тегов / ветвей?

Я проверил библиотеку sphinxcontrib-versioning, но поскольку она недавно не обновлялась, она кажется сломанной.Что-нибудь, что я могу изучить?Кто-нибудь может направить меня к источнику?

Заранее спасибо.

1 Ответ

0 голосов
/ 05 июля 2019

Вот один из способов опубликовать несколько версий ваших документов, используя в качестве примера Pyramid и Read Docs.

Сравните conf.py на ветви master с другими пронумерованными ветвями. Версии в значительной степени одинаковы, за исключением старых версий , которые мы добавляем к фиксированному тегу div с надписью «Прочитать последнюю версию этой страницы» и ссылками на последнюю стабильную версию, а для master ветка мы шлепаем на предупреждающий значок "ЗАМЕЧАНИЕ Документация в процессе".

Затем настроить RTD для создания нескольких версий ваших документов.

...