Como eu exporto todos os documentos do Python de um pacote e os coloco no Devhelp?

Question

No momento, para ler a documentação de um pacote, quickly para o exame, eu faço isso:

>>> import quickly
>>> help(quickly)
 
>>> import quickly.widgets
>>> help(quickly.widgets)
 
>>> import quickly.widgets.text_editor
>>> help(quickly.widgets.text_editor)
 

e assim por diante ...

Isso é obviamente muito tedioso. Como posso exportar toda a documentação rapidamente, incluindo todos os subpacotes, para que ela apareça no navegador de documentação devhelp ?

Exportar a documentação como HTML também seria bom. Eu ficaria feliz se alguma versão existisse na web, mas não consigo encontrar uma.

Observação: por pacote , quero dizer um python-package , não é um pacote .deb.

    

Answer 1

Você pode criar documentação HTML de um módulo python usando epydoc .

  

O Epydoc é uma ferramenta para gerar documentação da API para módulos Python, com base em suas docstrings.

Veja como usar epydoc para criar documentação em HTML para o módulo quickly.widgets :

epydoc --html quickly.widgets -o quickly_widgets_doc

Quando isso terminar, abra quickly_widgets_doc/index.html no seu navegador:

Ou, se preferir esta documentação em um PDF:

epydoc --pdf quickly.widgets --name "quickly.widgets" -o quickly_widgets_doc_pdf

Isso cria o arquivo quickly_widgets_doc_pdf/api.pdf

Mais informações sobre o uso de epydoc aqui .

Eu não encontrei uma maneira de convertê-los em um formato que o DevHelp possa usar. Se eu fizer isso, eu vou editar esta resposta.

    

Answer 2

O "segredo" pouco conhecido é a ferramenta pydoc incluída em todas as instalações do Python (portanto, não é necessário para instalar pacotes extras).

Inicie um servidor Web que gere uma documentação instantânea a partir da fonte (usando as mesmas técnicas de help() no console do Python) que escuta no link com:

pydoc -p 8000

Inicie o servidor da Web e uma GUI baseada em Tkinter que fornece opções de pesquisa, etc.:

pydoc -g

Grave a documentação de quickly.widgets em um arquivo HTML quickly.widgets.html no diretório atual:

pydoc -w quickly.widgets