Python pip - установить документацию для пакетов? - PullRequest
11 голосов
/ 15 ноября 2010

Есть ли способ установить / сгенерировать документацию для пакетов, установленных с помощью pip?

Я хочу установить все необходимые пакеты для проекта, а также всю связанную документацию (например, документацию Django при установке django, документацию по dateutil с dateutil и т.

Файлы требований Pip - отличный способ быстрой установки необходимых пакетов для проекта, но было бы еще лучше, если бы я мог также установить все связанные документы.

Пакеты Ubuntu Python устанавливают документацию в / usr / share / docs, но pip, похоже, не делает то же самое.

Документация для этих пакетов важна для меня, когда мне нужно работать над проектами в автономном режиме.

1 Ответ

4 голосов
/ 26 февраля 2011

Я думаю, вы ищете эквивалент тому, как ruby ​​автоматически (если не подавлен) генерирует rdoc из установленных гемов / пакетов.

В python является стандартизированным механизмом аннотирования кода с документацией - строк документации с необязательным форматированием . Однако не существует стандартизированного способа генерирования / хранения документации из кода Python. Каждый пакет python может иметь свой механизм, поэтому pip не может его сгенерировать.

...