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


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

Bug#1123787: ITP: sphinxcontrib-typer -- Sphinx directive to generate documentation for Typer and Click commands

Path csiph.com!weretis.net!feeder8.news.weretis.net!news.samoylyk.net!gothmog.csi.it!bofh.it!news.nic.it!robomod
From Edward Betts <edward@4angle.com>
Newsgroups linux.debian.bugs.dist, linux.debian.devel, linux.debian.maint.python
Subject Bug#1123787: ITP: sphinxcontrib-typer -- Sphinx directive to generate documentation for Typer and Click commands
Date Sun, 21 Dec 2025 17:30:01 +0100
Message-ID <M4utH-4C77-9@gated-at.bofh.it> (permalink)
X-Mailbox-Line From debian-bugs-dist-request@lists.debian.org Sun Dec 21 16:21:09 2025
Old-Return-Path <debbugs@buxtehude.debian.org>
X-Spam-Flag NO
X-Spam-Score -1.699
Reply-To Edward Betts <edward@4angle.com>, 1123787@bugs.debian.org
Resent-To debian-bugs-dist@lists.debian.org
Resent-Cc debian-devel@lists.debian.org, debian-python@lists.debian.org, wnpp@debian.org
X-Debian-Pr-Message report 1123787
X-Debian-Pr-Package wnpp
MIME-Version 1.0
Content-Type text/plain; charset=us-ascii
Content-Disposition inline
X-Debian-Message from BTS
X-Mailing-List <debian-bugs-dist@lists.debian.org> archive/latest/1943885
List-ID <debian-bugs-dist.lists.debian.org>
List-URL <https://lists.debian.org/debian-bugs-dist/>
Approved robomod@news.nic.it
Lines 32
Organization linux.* mail to news gateway
Sender robomod@news.nic.it
X-Original-Date Sun, 21 Dec 2025 15:50:22 +0000
X-Original-Message-ID <aUgWCsC4G3_7XUjH@4angle.com>
Xref csiph.com linux.debian.bugs.dist:1275417 linux.debian.devel:119957 linux.debian.maint.python:17282

Cross-posted to 3 groups.

Show key headers only | View raw


Package: wnpp
Severity: wishlist
Owner: Edward Betts <edward@4angle.com>
X-Debbugs-Cc: debian-devel@lists.debian.org, debian-python@lists.debian.org

* Package name    : sphinxcontrib-typer
  Version         : 0.7.0
  Upstream Author : Brian Kohan <bckohan@gmail.com>
* URL             : https://github.com/sphinx-contrib/typer
* License         : MIT
  Programming Lang: Python
  Description     : Sphinx directive to generate documentation for Typer and Click commands

  Provides a Sphinx extension that adds a "typer" reStructuredText directive for
  documenting command-line interfaces defined with Typer or Click.
  .
  During a Sphinx build, the directive imports the referenced command or
  application object and extracts its help output, including usage text,
  options, arguments, and subcommands. It can expand subcommands and, when
  requested, generate separate sections per command so that a command tree can
  be rendered as structured documentation.
  .
  The rendered command help can be embedded into Sphinx output in multiple
  formats, including plain text, HTML, and SVG. When HTML or SVG is selected,
  the output is based on the same console-style formatting used by the command
  when producing its help text.
  .
  This library primarily interacts with Sphinx at build time and with the Typer
  or Click command objects being documented, invoking their help formatting to
  obtain the content that is inserted into the generated documentation.

I plan to maintain this package as part of the Python team.

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


Thread

Bug#1123787: ITP: sphinxcontrib-typer -- Sphinx directive to generate documentation for Typer and Click commands Edward Betts <edward@4angle.com> - 2025-12-21 17:30 +0100

csiph-web