all options
sid  ]
[ Source: sphinxcontrib-typer  ]

Package: python3-sphinxcontrib-typer (0.8.0-1)

Links for python3-sphinxcontrib-typer

Screenshot

Debian Resources:

Download Source Package sphinxcontrib-typer:

Maintainers:

External Resources:

Similar packages:

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.

Other Packages Related to python3-sphinxcontrib-typer

  • depends
  • recommends
  • suggests
  • enhances

Download python3-sphinxcontrib-typer

Download for all available architectures
Architecture Package Size Installed Size Files
all 86.1 kB930.0 kB [list of files]