Générateur de documentation de Python

Question

Je suis à la recherche d'un générateur de documentation pour python. Je suis familier avec javadoc, et j'ai essayé d' Doxygen, mais il semble tout à fait impropre et contre-intuitif pour Python.

Des idées?

EDIT: à Part les excellentes réponses ci-dessous, vous pouvez également consulter la page wikipedia exhaustive Comparaison de la documentation des générateurs.

Answer 1

L'outil classique pour la doc API est epydoc. Elle gère la javadoc, docstrings, etc... Mais je trouve les docs de l'API outils pour être tout à fait mauvais. Je préfère de beaucoup l'outil qui se concentrent autour de la documentation elle-même, et permet d'injecter plus de documentation extraite du code. Sphinx est parfait pour ce travail. Il peut génère du code html et pdf, vous pouvez inclure des extraits automatiquement docstring de code, il ne la coloration syntaxique, etc... Un point fort de sphinx est qu'il est fait par quelqu'un qui sait quelque chose à propos de la conception web, et ne pas ressembler à un**. matplotlib site web et la doc est produite entièrement à partir de sphinx, avec des valeurs par défaut. Il a l'air beaucoup plus sympa que ce que vous obtiendrez avec epydoc/doxygen. Et il y a un moteur de recherche intégré dans le code javascript

Answer 2

Jetez un oeil sur Sphinx. Il y a un grand nombre d’utilisateurs, y compris Python lui-même.

Answer 3

J’ai utiliser Pydoc (http://docs.python.org/library/pydoc.html) pour générer tous les documents pour mon code python

Answer 4

Ce n'est pas exactement s'adapter à votre question, mais dans l'un de nos projets, nous nous sommes retrouvés avec un lettré de la programmation de l'approche.

Nous ne voulons pas avoir tous les commentaires et explications traîner dans le python source code, mais aussi ne veux pas écrire de la documentation à partir de zéro.

Alors nous écrire nos fichiers source avec un mélange de restructurés de texte et de code python (qui peut être bien fait à l'aide de PyLit).

Que nous générons notre documentation avec Sphinx et les fichiers source avec PyLit.

Cela donne beaucoup de liberté pour notre documentation (ajout d'images, de liens etc.) tout en gardant le python véritable fichier de code source libre d'inutiles explications (à partir d'un programme de point de vue).

Ainsi, un PyLit segment des fichiers comme ceci:

serait généré ce fichier source:

et cette documentation:

Answer 5

qu’en est-il des sphinx? C’est un outil qui le rend facile de créer une documentation intelligente et beau
Et Expert Python programmation inclut un chapitre (chap 10) pour documenter votre projet