Package: wnpp Severity: wishlist Owner: Edward Betts <[email protected]> X-Debbugs-Cc: [email protected], [email protected]
* Package name : sphinxcontrib-typer Version : 0.7.0 Upstream Author : Brian Kohan <[email protected]> * 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.
