Как публиковать документацию, сгенерированную sphinx, на битрейт wiki автоматически?

У меня есть пакет python с созданной sphinx документацией (с использованием функции автомодулей), и он может быть превращен в набор статических html-страниц, расположенных в каталоге _build в репозитории git проекта. Я хотел бы посмотреть эту документацию красивым и личным образом на битбакете. Кажется, что вики, которая является git репо сама может быть полезной для этого.

Есть ли простой шаг последовательностей, которые могут сделать/преобразовать мою html-документацию в разметку и вставить ее в репозиторий wiki файла bitbucket?

Ответ 1

К сожалению, это действительно невозможно...

Вы можете переместить ваш каталог _build в реплику wiki и создать ссылки в wiki (Home.rst) в ваши html файлы следующим образом:

`Sphinx docs <_build/html/index.html>`_

И он отобразит их, но включение _static файлов css/js не будет работать, поэтому ваши документы будут выглядеть уродливыми: (

Вы также можете публиковать свои документы в качестве веб-сайта в BitBucket, но нет конфиденциальности, ваши документы будут общедоступными, даже если ваше репо является приватным, поэтому это не очень полезно, тогда вы можете просто пойти с прочитать документы...

Прочитайте документы фактически поддерживает конфиденциальность, чтобы вы могли добавить свои документы в приватном режиме и добавить Webhook в BitBucket. Это, к сожалению, работает только с публичными репозиториями, поэтому не является отличным решением...

P.S. Там есть приложение для повторного использования, которое позволяет вам частным образом обслуживать ваши документы сфинкса из django (protected): django-docs;) И вы можете создавать их из своих файлов *.rst файла bitbucket...