Re: Debian-way мануалы для python-скриптов
В Thu, 23 Apr 2020 11:51:48 +0400
a.v.korotkov@gmail.com пишет:
> On Thu, 23 Apr 2020 09:34:37 +0300
> Victor Wagner wrote:
>
> VW> dh_python из коробки поддерживает систему документирования sphynx,
> VW> Но я заглянул в её описание и понял, что ничего не понял. Она
> VW> ориентирована в первую очередь на написание документации к
> VW> библиотека, для программистов, а не на man-страницы, для
> VW> пользователей.
>
> В сторону Asciidoc гляньте (сам не пробовал).
Дело не в том, какой язык разметки использовать.
В конце концов писал я 20 лет маны непосредственно на *roff.
Вопрос в интеграции конвертера этого языка с дебиановскими средствами
пакетирования python-скриптов и самим setuptools. Нужно с одной стороны
обеспечить, чтобы setup.py не забыл положить исходник документации в tarball
исходников по команде sdist, с другой, чтобы в debian/rules отработало
правило, которое уже преобразованные в *roff man-страницы установило в
/usr/share/man/man1 и /usr/share/man/ru/man1.
Если же это правило писать вручную через override_dh_auto_install, то
придется потом debian/rules хранить в git, а не перегенерировать каждый
раз с помощью py2dsp из пакета pypi2deb.
У asciidoc я никаких средств для этого
не увидел. У sphynx это есть, но непонятно как в spynx c минимальными
трудозатратами сделать правильные man-страницы, со стандартным для
man набором разделов.
--
Reply to: