web-dev-qa-db-fra.com

Comment exporter tous les Python docs d'un package et les importer dans Devhelp?

Pour le moment, pour lire la documentation d'un paquet, quickly par exemple, je fais ceci:

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

etc...

C'est évidemment très fastidieux. Comment puis-je exporter toute la documentation rapidement, y compris tous les sous-packages, puis la faire apparaître dans le navigateur de documentation devhelp?

Exporter la documentation en HTML serait bien aussi. Je serais même heureux si une version de celle-ci existait sur le Web, mais je n'arrive pas à en trouver une.

Remarque: Par package je veux dire un alt textpython-package , pas un paquet .deb.

programmingpythondocumentation
6
Stefano Palazzo

Vous pouvez créer une documentation HTML d'un module python à l'aide de epydocInstall epydoc .

Epydoc est un outil permettant de générer une documentation API pour les modules Python, en fonction de leurs docstrings.

Voici comment utiliser epydoc pour créer une documentation HTML pour le module quickly.widgets:

epydoc --html quickly.widgets -o quickly_widgets_doc

Une fois cette opération terminée, ouvrez quickly_widgets_doc/index.html dans votre navigateur Web:

alt text

Ou, si vous préférez cette documentation au format PDF:

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

Ceci crée le fichier quickly_widgets_doc_pdf/api.pdf

alt text

Plus d'informations sur l'utilisation de epydocici .

Je n'ai pas trouvé de moyen de les convertir en un format que DevHelp peut utiliser. Si tel est le cas, je modifierai cette réponse.

6
Isaiah

Le secret que je connais peu est le outil pydoc inclus avec chaque installation Python (il n'est donc pas nécessaire d'installer des packages supplémentaires).

Démarrez un serveur Web qui génère une documentation instantanée à partir de la source (en utilisant les mêmes techniques que help() dans la console Python qui écoute) http: // localhost: 8000 / avec:

pydoc -p 8000

Lancez le serveur Web et une interface graphique basée sur Tkinter offrant des options de recherche, etc.:

pydoc -g

Ecrivez la documentation de rapid.widgets dans un fichier HTML rapidement.widgets.html dans le répertoire en cours:

pydoc -w quickly.widgets
4
JanC