2010-11-15 23 views
11

Existe-t-il un moyen d'installer/de générer la documentation pour les paquets installés avec pip?Python pip - installer la documentation pour les paquets?

Je souhaite installer tous les packages requis pour un projet, ainsi que toute la documentation associée (par exemple de la documentation Django lors de l'installation django, dateutil documentation avec dateutil etc.).

fichiers exigences Pip sont une excellente façon d'installer rapidement les paquets nécessaires pour un projet, mais il serait encore mieux si je pouvais aussi installer tous les documents associés ainsi.

paquets Python Ubuntu installe la documentation dans/usr/share/docs, mais pip ne semble pas faire la même chose.

Documentation pour ces paquets est important pour moi quand je dois travailler sur des projets hors ligne.

+0

Je ne sais pas comment le télécharger depuis pip mais beaucoup de développeurs supportent epydoc que vous pouvez utiliser pour générer la documentation automatiquement. – Joshkunz

Répondre

4

Je pense que vous êtes à la recherche d'un équivalent à la façon dont ruby ​​automatiquement (sauf suppression) génère rdoc de pierres précieuses/packages installés.

En python, il est un mécanisme normalisé pour le code annoter avec la documentation - docstrings avec optional formatting. Cependant, il n'existe pas de manière standardisée de générer/stocker de la documentation à partir du code python. Chaque paquet python peut avoir un mécanisme différent, donc il ne peut pas y avoir de moyen pour que pyth le génère.