2010-11-15 35 views
11

¿Hay alguna forma de instalar/generar la documentación de los paquetes instalados utilizando pip?Python pip: ¿instalar la documentación de los paquetes?

Deseo instalar todos los paquetes necesarios para un proyecto, así como toda la documentación asociada (por ejemplo, documentación de Django al instalar django, documentación de dateutil con dateutil, etc.).

Los archivos de requisitos Pip son una forma excelente de instalar rápidamente los paquetes necesarios para un proyecto, pero sería aún mejor si también pudiera instalar todos los documentos asociados.

Los paquetes de Ubuntu Python instalan la documentación en/usr/share/docs, pero pip no parece hacer lo mismo.

La documentación de estos paquetes es importante para mí cuando necesito trabajar en proyectos fuera de línea.

+0

No sé cómo descargarlo de pip, pero muchos desarrolladores admiten epydoc, que puede usar para generar la documentación automáticamente. – Joshkunz

Respuesta

4

Creo que está buscando un equivalente a la forma en que el rubí automáticamente (a menos que se suprima) genera rdoc a partir de las gemas/paquetes instalados.

en Python, no es un mecanismo estandarizado para la anotación de código con la documentación - docstrings con optional formatting. Sin embargo, no existe una forma estandarizada de generar/almacenar documentación del código python. Cada paquete de Python puede tener un mecanismo diferente, por lo que no podría haber una forma de que pip lo genere.

Cuestiones relacionadas