Program wiersza poleceń Pythona: generuj stronę podręcznika z istniejącej dokumentacji i włącz do dystrybucji

Po (miejmy nadzieję) powszechnej praktyce mam pakiet Pythona, który zawiera kilka modułów i skrypt wykonywalny w osobnymscripts katalog, jak widaćtutaj.

Dokumentacja skryptu, oprócz automatycznie wygenerowanej pomocy dostarczonej przez optparse, jest razem z dokumentacją pakietu w podkatalogu Sphinx. Próbuje:

wygeneruj stronę podręcznika dla skryptu z istniejącej dokumentacjidołącz stronę man do dystrybucji

Mogę łatwo zrobić # 1 ze Sphinxem, theman_pages ustawienie isphinx-build -b man. Więc mogę zadzwonićpython setup.py build_sphinx -b man i wygeneruj stronę man wbuild/sphinx/man informator.

Teraz chciałbym mieć dostęp do wygenerowanej strony man w archiwum dystrybucyjnym, więc pakujący GNU / Linux mogą go znaleźć i zainstalować w odpowiednim miejscu. Różne opcje, takie jakpackage_data nie działa tutaj, ponieważ strony man nie ma tam, dopóki nie zostanie wygenerowany przez Sphinx. Może to również dotyczyć plików i18n (.mo vs.po pliki).

W tym pliki, które nie są częścią źródła wMANIFEST.in nie wydaje się właściwe. Możliwość zatwierdzenia wygenerowanych plików do repozytorium źródłowego wygląda na okropną rzecz do zrobienia i chciałbym tego uniknąć.

Powinien istnieć jeden - a najlepiej tylko jeden - oczywisty sposób, aby to zrobić.

questionAnswers(4)

yourAnswerToTheQuestion