Как я экспортирую все документы Python пакета и получаю его в Devhelp?
В данный момент, для чтения документации пакета, quickly для примера я делаю это:
>>> import quickly
>>> help(quickly)
>>> import quickly.widgets
>>> help(quickly.widgets)
>>> import quickly.widgets.text_editor
>>> help(quickly.widgets.text_editor)
и так далее...
Это очевидно очень утомительно. Как я могу экспортировать весь из быстро документация, включая все подпакеты, затем заставить это обнаруживаться в devhelp браузер документации?
При экспорте документации, поскольку HTML был бы хорош также. Я даже был бы счастлив, если бы некоторая версия его существовала в сети, но я, может казаться, не нахожу тот.
Примечание: Пакетом я имею в виду
пакет Python, не .deb пакет.
2 ответа
Можно создать документацию HTML модуля Python с помощью epydoc .
Epydoc является инструментом для генерации документации API для модулей Python, на основе их docstrings.
Вот то, как использовать epydoc создать документацию HTML для модуля quickly.widgets:
epydoc --html quickly.widgets -o quickly_widgets_doc
После того как это заканчивается, открыться quickly_widgets_doc/index.html в Вашем веб-браузере:
Или, если Вы предпочли бы эту документацию в PDF:
epydoc --pdf quickly.widgets --name "quickly.widgets" -o quickly_widgets_doc_pdf
Это создает файл quickly_widgets_doc_pdf/api.pdf
Больше информации об использовании epydoc здесь.
Я не нашел способ преобразовать их в формат, который может использовать DevHelp, если я сделаю то я отредактирую этот ответ.
Я мало известного "секрета" является pydoc инструментом, который включен с каждой установкой Python (так никакая потребность установить дополнительные пакеты).
Запустите веб-сервер, который генерирует мгновенную документацию из источника (использующий те же методы как help() в консоли Python), который слушает на http://localhost:8000/ с:
pydoc -p 8000
Запустите веб-сервер и находящийся в Tkinter GUI, который предоставляет возможности поиска и т.д.:
pydoc -g
Запишите документацию для quickly.widgets в файл HTML quickly.widgets.html в текущем каталоге:
pydoc -w quickly.widgets