2010-11-15 1 views
11

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

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

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

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

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

+0

Я не знаю, как загрузить его из pip, но многие разработчики поддерживают epydoc, которые вы можете использовать для автоматической генерации документации. – Joshkunz

ответ

4

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

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

 Смежные вопросы

  • Нет связанных вопросов^_^