Установите справочные страницы пакета python с помощью pip

Question

Я поддерживаю скомпилированную установку Python в /opt/python-2.7.6, Я ожидаю, что страницы man будут установлены в share/man, Я установил несколько библиотек, уже используя pip (numpy, scipy, matplotlib, sympy). Я не уверен, если они должны прийти с страницами руководства.

Теперь я установил pygments, Он поставляется с двоичным файлом pygmentize, который правильно установлен в bin,

Боковое отслеживание: я посмотрел файлы в пакете Debian python-pygments и это идет с страницей руководства:

$ apt-file list python-pygments
...
/usr/share/man/man1/pygmentize.1.gz
...

Вернуться к основной теме: я не хочу устанавливать python-pygments с apt-get потому что это будет связано с системой Python. Я хочу продолжать использовать pip поддерживать мою пользовательскую установку Python. Должно быть легко добавить share/man каталог к MANPATH переменная окружения с использованием .bashrc

export MANPATH=/opt/python-2.7.6/share/man:$MANPATH

Вопрос: как мне пользоваться pip установить страницы руководства вместе с библиотекой Python?

Answer 1

Пакет не имеет справочной страницы, смотрите здесь. Политика Debian требует, чтобы каждая программа добавляла страницу руководства. Следовательно, пакет устанавливает один для вас.

Как примечание стороны

Если вы поддерживаете свой собственный пакет, вы можете использовать директиву data_files в вашем setup.py:

setup(
   ...
   data_files = [('man/man1', [path/to/your/manpage.1/'])],
   )

Если вы хотите автоматически создать страницу руководства для вашей программы (если вы используете argparse, взгляните на man-utils.