Jak automatycznie publikować dokumentację generowaną przez Sphinx na wiki BitBucket?

Question

Mam pakiet Pythona z dokumentacją generowaną przez sfinksa (przy użyciu funkcji automulule) i można go przekształcić w zestaw statycznych stron HTML w katalogu _build w repozytorium git projektu. Chciałbym zobaczyć tę dokumentację w ładny i prywatny sposób na bitbucket. Wygląda na to, że wiki, które jest repozytorium git, może być do tego przydatne.

Czy istnieje prosty krok sekwencji, które mogą przekształcić moją dokumentację HTML w znaczniki i przenieść ją do repozytorium wiki bitbucket?

Answer 1

Niestety nie jest to możliwe ...

można wypchnąć _build dir do repo wiki i tworzenia powiązań w wiki (Home.rst) do plików html tak:

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

I będzie je wyświetlać, ale włączenie _static css/js plików nie będzie działać, więc swoje dokumenty będą wyglądać brzydki :(

można też publish your docs as a website on BitBucket ale nie ma prywatności, swoje dokumenty będą publiczne, nawet jeśli repo jest prywatny, więc nie jest to zbyt użyteczne, n można po prostu przejść z read the docs ...

Przeczytać dokumenty faktycznie supports privacy, dzięki czemu można dodać dokumenty w trybie prywatnym i dodać Webhook w BitBucket. To niestety działa tylko w przypadku publicznych repozytoriów, więc nie jest to wspaniałe rozwiązanie ...

P.S. Jest to aplikacja do wielokrotnego użytku, która pozwala ci prywatnie serwować twoje sfinksy od django (chronione): django-docs;) I możesz je zbudować z plików bitbucket * .rst ...