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

Peter Pentchev <[email protected]> Mon, 11 May 2020 16:15:08 +0300
Newsgroups	gmane.linux.debian.user.russian
Message-ID	<[email protected]>
On Mon, May 11, 2020 at 11:03:40AM +0300, Victor Wagner wrote:
> В Sun, 10 May 2020 23:31:41 +0300
> Peter Pentchev <[email protected]> пишет:
> 
> > On Thu, Apr 23, 2020 at 12:15:52PM +0300, Victor Wagner wrote:
> > > В Thu, 23 Apr 2020 11:51:48 +0400
> > > [email protected] пишет:
> > >   
> > > > On Thu, 23 Apr 2020 09:34:37 +0300
> > > > Victor Wagner wrote:
> > > >   
> > > > VW> dh_python из коробки поддерживает систему документирования
> > > > VW> sphynx, Но я заглянул в её описание и понял, что ничего не
> > > > VW> понял. Она ориентирована в первую очередь на написание
> > > > VW> документации к библиотека, для программистов, а не на
> > > > VW> man-страницы, для пользователей.    
> > > > 
> > > > В сторону Asciidoc гляньте (сам не пробовал).  
> > > 
> > > Дело не в том, какой язык разметки использовать.
> > > 
> > > В конце концов писал я 20 лет маны непосредственно на *roff.  
> > [snip]
> > 
> > BTW пробовали когда-то -mdoc? Мне всегда казалось, что лучше
> > использовать семантичних макросов, а не типографских.
> 
> В -man более чем достаточно семантических макросов.
> Да, в некоторых сообществах принят такой стиль, когда используют
> физическую разметку, например в Tcl это очень любят. Но это именно
> заморочки конкретных сообществ. 

Ну, мне -mdoc более чем 20 лет назад во FreeBSD научили :)

> в> > Если же это правило писать вручную через override_dh_auto_install,
> > > то придется потом debian/rules хранить в git, а не перегенерировать
> > > каждый раз с помощью py2dsp из пакета pypi2deb.  
> > 
> > Если Вы уже используете debhelper, тогда у Вас dh_installman
> > вызывается автоматично, так что опишите something.1 и another.1
> > в debian/manpages, он их поставит. Конечно, если самие *.1
> 
> Это все, конечно хорошо, но как объяснить питноовскому setuptools
> что по команде setup.py sdist их надо в orig.tar.gz положить?

setuptools.setup(
    ...,
    data_files=[
        ("/usr/share/man/man1", ["progname.1", "another.1"]),
    ],
    ...,
)

Не то?

Ну, не всегда очень хорошо работает с wheels :(

> > не в upstream source, debian/manpages может содержать и пут
> 
> В том-то и дело, что мне  хочется сформировать такой upstream source,
> который был бы весь из себя pythonway, настолько что я бы мог не
> заботиться о ручном написании содержимого директории debian,
> зная что py2dsc все сделает правильно.
> 
> Я не хочу хранить  debian/* в version control, хочу их каждый раз
> воссоздавать автоматически

Понятно; извините, мне следовало бы сразу понять - Вы говорили о том.

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

-- 
Peter Pentchev  [email protected] [email protected] [email protected]
PGP key:        http://people.FreeBSD.org/~roam/roam.key.asc
Key fingerprint 2EE7 A7A5 17FC 124C F115  C354 651E EFB0 2527 DF13
signature.asc (application/pgp-signature, 833 B)