[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Re: Debian-way мануалы для python-скриптов



On Thu, Apr 23, 2020 at 12:15:52PM +0300, Victor Wagner wrote:
> В 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.
[snip]

BTW пробовали когда-то -mdoc? Мне всегда казалось, что лучше
использовать семантичних макросов, а не типографских.
Пример: https://gitlab.com/confget/confget/-/blob/master/confget.1

> Если же это правило писать вручную через override_dh_auto_install, то
> придется потом debian/rules хранить в git, а не перегенерировать каждый
> раз с помощью py2dsp из пакета pypi2deb.

Если Вы уже используете debhelper, тогда у Вас dh_installman
вызывается автоматично, так что опишите something.1 и another.1
в debian/manpages, он их поставит. Конечно, если самие *.1
не в upstream source, debian/manpages может содержать и пути
внутри debian/*, как в https://sources.debian.org/src/mktorrent/1.1-2/debian/manpages/

Всего лучшего,
Петр

-- 
Peter Pentchev  roam@ringlet.net roam@debian.org pp@storpool.com
PGP key:        http://people.FreeBSD.org/~roam/roam.key.asc
Key fingerprint 2EE7 A7A5 17FC 124C F115  C354 651E EFB0 2527 DF13

Attachment: signature.asc
Description: PGP signature


Reply to: