{"categories":[{"label":"Python Modules","url":"https://skillfed.io/packages/category/software-development-libraries-python-modules/22"},{"label":"Utilities","url":"https://skillfed.io/packages/category/utilities/11"},{"label":"Documentation","url":"https://skillfed.io/packages/category/documentation/2"},{"label":"Sphinx","url":"https://skillfed.io/packages/category/documentation-sphinx"}],"enrichment":{"capability":"A Sphinx extension that auto-generates documentation for Typer CLI applications, rendering command help text in HTML, SVG, or text format using Typer's rich console formatting.","skillfed_tags":["cli-documentation","sphinx-extension","typer"],"use_cases":["Generate formatted command reference pages in your project documentation from live Typer CLI code.","Keep CLI documentation in sync with code by auto-rendering help text instead of maintaining separate docs.","Export CLI help as SVG diagrams for inclusion in HTML or PDF documentation.","Document multi-command Typer applications with separate sections for each subcommand.","Create polished, styled CLI reference documentation with rich formatting without manual markup."],"what_it_does":"sphinxcontrib-typer is a Sphinx extension that introspects Typer CLI applications and automatically generates formatted documentation from their command definitions, options, and help text. It bridges the gap between your CLI code and your Sphinx documentation by rendering command help output directly into your docs in HTML, SVG, or plain text formats, using Typer's rich console formatting for polished output.\n\nYou add the extension to your Sphinx conf.py, then use a simple typer directive in your .rst files to point at a Typer app object. The extension imports and inspects that app, extracts its structure and help text, and renders it as formatted documentation. It supports documenting callback functions, individual commands, and subcommands, with options to control output width, format preference, and console rendering behavior.","worth_installing":"Yes. Active maintenance, no known vulnerabilities, low install friction, and a clear niche: if you document Typer CLIs in Sphinx, this extension saves you from manually maintaining duplicate help text. The MIT license is unrestricted. Not needed if you use Click directly or prefer other documentation approaches."},"id":"sphinxcontrib-typer","links":{"html":"https://skillfed.io/packages/sphinxcontrib-typer","md":"https://skillfed.io/packages/sphinxcontrib-typer.md","pypi":"https://pypi.org/project/sphinxcontrib-typer/"},"maintenance":{"status":"active"},"meta":{"latest_release":"2026-06-29","license_spdx":"MIT","license_treatment":"permissive","name":"sphinxcontrib-typer","python_support":"supports_current","summary":"Auto generate docs for typer commands."},"popularity":{"monthly_downloads":80001,"position":14325,"tier":"top_15000"},"security":{"n_vulnerabilities":0},"version":"0.9.1"}
