Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]


Groups > linux.debian.maint.python > #11358

Bug#924099: RFP: click-man -- Automate generation of man pages for python click applications

Path csiph.com!news.mixmin.net!aioe.org!bofh.it!news.nic.it!robomod
From Nicolas Braud-Santoni <nicoo@debian.org>
Newsgroups linux.debian.bugs.dist, linux.debian.maint.python
Subject Bug#924099: RFP: click-man -- Automate generation of man pages for python click applications
Date Sat, 09 Mar 2019 16:10:02 +0100
Message-ID <xzLLP-6zj-3@gated-at.bofh.it> (permalink)
X-Original-To Debian Bug Tracking System <submit@bugs.debian.org>
X-Mailbox-Line From debian-bugs-dist-request@lists.debian.org Sat Mar 9 15:09:10 2019
Old-Return-Path <debbugs@buxtehude.debian.org>
X-Spam-Flag NO
X-Spam-Score -4.2
Reply-To Nicolas Braud-Santoni <nicoo@debian.org>, 924099@bugs.debian.org
Resent-To debian-bugs-dist@lists.debian.org
Resent-Cc debian-python@lists.debian.org, tuxtimo@gmail.com, wnpp@debian.org
X-Debian-Pr-Message report 924099
X-Debian-Pr-Package wnpp
X-Spam-Bayes score:0.0000 Tokens: new, 85; hammy, 149; neutral, 75; spammy, 1. spammytokens:0.974-+--click hammytokens:0.000-+--manpage, 0.000-+--HX-Debbugs-Cc:sk:debian-, 0.000-+--H*M:reportbug, 0.000-+--H*MI:reportbug, 0.000-+--sha512
Content-Type text/plain; charset="us-ascii"
MIME-Version 1.0
Content-Transfer-Encoding 7bit
X-Mailer reportbug 7.5.2
X-Debian-Message from BTS
X-Mailing-List <debian-bugs-dist@lists.debian.org> archive/latest/1525891
List-ID <debian-bugs-dist.lists.debian.org>
List-URL <https://lists.debian.org/debian-bugs-dist/>
Approved robomod@news.nic.it
Lines 59
Organization linux.* mail to news gateway
Sender robomod@news.nic.it
X-Original-Date Sat, 09 Mar 2019 16:05:08 +0100
X-Original-Message-ID <155214390865.23914.16466722227234976999.reportbug@neon.citronna.de>
Xref csiph.com linux.debian.bugs.dist:948981 linux.debian.maint.python:11358

Cross-posted to 2 groups.

Show key headers only | View raw


Package: wnpp
Severity: wishlist

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA512

* Package name    : click-man
  Version         : 0.3.0
  Upstream Author : Timo Furrer <tuxtimo@gmail.com>
* URL             : https://github.com/click-contrib/click-man
* License         : MIT
  Programming Lang: Python
  Description     : Automate generation of man pages for python click applications


click-man is a tool that can automatically generate manpages for application
written with the click CLI framework.  It provides setuptools integration and
can easily be used during the build of a Debian package:

  https://github.com/click-contrib/click-man#debian-packages


As far as I know, current packaging practices involve either
1. writing a manpage by hand, which is a lot of work
2. generating it ahead-of-time with help2man or somesuch, and commiting it to
   the debian/ directory, where it might get out-of-sync with the actual program
3. not shipping manpages at all  :(

Automatically generating a manpage during package build would definitely be
preferable to (2) and (3), and possibly to (1) if the result is of sufficient
quality.


I cannot currently commit to packaging and maintaining this package, hence why I
am filing a RFP, and in any case I would probably appreciate having a
comaintainer.  :)


Best,

  nicoo

-----BEGIN PGP SIGNATURE-----

iQJFBAEBCgAvFiEEU7EqA8ZVHYoLJhPE5vmO4pLV7MsFAlyD1iERHG5pY29vQGRl
Ymlhbi5vcmcACgkQ5vmO4pLV7MtFEg//bMCSVlPiWW3qMjpJ45jKT058nK/Npyh4
ua0qh4ui0DzTC4i6AMr1Pp+L1dgnK92QlWBCsq06OKsxE2c/CezLIUNfeYgUGPIx
dzDjOk1dFqkgdjyorFH45rcaQX1CuASamcq5UlVF3aCGrf/e/WaL4VCVf1/Dv942
xHMncmdm1WA7gptiW7ovh+zLLA1ku9Vp+pbGuYmlpNP4npJ1ZM0W9eaEYhaX0Qpc
ucsingbjtfECUScwuJ892TAONt1hAvgyCBOJbpCgemj4GUXVvKfbXneXoF7LfC0F
NIk+OmKfhGjyqQRtw8QJnhrCwGvHFS+As2f2nFoIjIApY3Vq/UnQZ2gT0O1Iz+JW
WFFTeCeF2RDYTGJZgnW+B4+k9dAbcjkcT/qpIAU/PNj2ahzWfbCkmQjugrnh3Fgj
v+P7vBN8iIVolcAKZ5EL7axpHNHkJJAvI/rzGJs+VJQZBnbQMBdYc1M7sf10g4KL
gxsfw62+mx+J+MOsl9i+eGc35OeuYTi9NZ3yGM1fk7xNAb5Q2gPXvJ7bVGEUJcmy
4hXsFCrUDw7dK58DbQGF+O4VpwhhqPtI7I2CnKyMu7F44MZwikbDVOJ4q3GE5hdQ
7VXwRlDSwnCa/x0p/fX0KK1b6ZE8doIRRzfRz67mglijl8C+6LeWr51i/5z+JeZ3
pnsKpYtQgaA=
=Uh8t
-----END PGP SIGNATURE-----

Back to linux.debian.maint.python | Previous | Next | Find similar | Unroll thread


Thread

Bug#924099: RFP: click-man -- Automate generation of man pages for python click applications Nicolas Braud-Santoni <nicoo@debian.org> - 2019-03-09 16:10 +0100

csiph-web