2010-11-15 2 views
11

C'è un modo per installare/generare la documentazione per i pacchetti installati usando pip?Python pip - installa la documentazione per i pacchetti?

Desidero installare tutti i pacchetti richiesti per un progetto, nonché tutta la documentazione associata (ad esempio documentazione di Django durante l'installazione di django, datautil documentazione con datautil ecc.).

I file di requisiti Pip sono un ottimo modo per installare rapidamente i pacchetti richiesti per un progetto, ma sarebbe anche meglio se potessi installare anche tutti i documenti associati.

I pacchetti di Ubuntu Python installano la documentazione in/usr/share/docs, ma pip non sembra fare lo stesso.

La documentazione di questi pacchetti è importante per me quando devo lavorare su progetti offline.

+0

Non so di scaricarlo da pip ma molti sviluppatori supportano epydoc che è possibile utilizzare per generare automaticamente la documentazione. – Joshkunz

risposta

4

Penso che tu stia cercando un equivalente al modo in cui ruby ​​automaticamente (a meno che non sia soppresso) genera rdoc da gemme/pacchetti installati.

in Python, ci è un meccanismo standardizzato per annotare il codice con la documentazione - docstrings con optional formatting. Tuttavia non esiste un modo standardizzato di generare/archiviare la documentazione dal codice Python. Ogni pacchetto Python può avere un meccanismo diverso, quindi non ci potrebbe essere un modo per pip di generarlo.