sphinxcontrib-typer
Auto generate docs for typer commands.
Decision gist · record as of 2026-08-14
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.AI-flagged interpretation of the facts on this page — verify before relying
Before you install
- Your Typer application must be importable from the Python path when Sphinx builds the docs; add the path to sys.path in conf.py before the extension loads.
- Low friction install with just two runtime dependencies (sphinx and typer).
- Active maintenance with a recent release 46 days ago and no known vulnerabilities.
License · maintenance · safety
MIT (permissive) — MIT license permits unrestricted use, modification, and distribution in both open and closed projects with minimal obligations.
last release 2026-06-29 (46 days) · last repo commit 2026-08-03 · 26 stars
0 known vulnerabilities (OSV.dev, 2026-08-14) · 80,001 downloads/mo, #14,325 on PyPI
Alternatives
Verify before relying
pip install sphinxcontrib-typer
# In conf.py:
extensions = [
'sphinxcontrib.typer',
]
# In your .rst file:
# .. typer:: examples.example.app
# :prog: example1
# :preferred: html- Whether the package handles complex nested subcommand structures beyond the documented examples.
- Performance characteristics when documenting very large CLI applications with many commands.
What it is and 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.
You 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.
Use it for
- 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.
Worth the install?
AI-flagged interpretation of the facts on this page. Verify before relying on it.
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.
Install
sphinxcontrib-typer on PyPI
Before you install
Low friction install with just two runtime dependencies (sphinx and typer). Active maintenance with a recent release 46 days ago and no known vulnerabilities.
Your Typer application must be importable from the Python path when Sphinx builds the docs; add the path to sys.path in conf.py before the extension loads.
License in practice
MIT license permits unrestricted use, modification, and distribution in both open and closed projects with minimal obligations.
Quickstart
pip install sphinxcontrib-typer
# In conf.py:
extensions = [
'sphinxcontrib.typer',
]
# In your .rst file:
# .. typer:: examples.example.app
# :prog: example1
# :preferred: htmlVerify before relying
- Whether the package handles complex nested subcommand structures beyond the documented examples.
- Performance characteristics when documenting very large CLI applications with many commands.
Package facts
| License | MIT permissive |
| Python support | Supports the current Python release <4.0,>=3.10 |
| Install friction | Low. Pure-Python wheel |
| Runtime dependencies | 2 packagessphinxtyper |
| Maintenance | Actively maintained 46 days since the last release |
| Last repo commit | |
| First released | |
| Downloads | 80,001 / month, #14,325 on PyPI 30-day window, as of 2026-08-14 |
| Known vulnerabilities | None known OSV.dev, checked 2026-08-14 |
| Classifiers | Development Status :: 5 - Production/StableEnvironment :: ConsoleEnvironment :: Web EnvironmentFramework :: SphinxFramework :: Sphinx :: ExtensionIntended Audience :: DevelopersLicense :: OSI Approved :: MIT LicenseOperating System :: OS IndependentProgramming Language :: PythonProgramming Language :: Python :: 3.10Programming Language :: Python :: 3.11Programming Language :: Python :: 3.12Programming Language :: Python :: 3.13Programming Language :: Python :: 3.14Topic :: DocumentationTopic :: Documentation :: SphinxTopic :: Software Development :: Libraries :: Python ModulesTopic :: Utilities |
Evidence: sphinxcontrib_typer-0.9.1-py3-none-any.whl
Tags
Let your AI agent find packages like this
Example. Real query, live index.
You found this page by searching. An agent finds it by wishing: SkillFed indexes 14,416 PyPI packages by what they can do, searchable in plain language.
wish › “sphinx typer documentation”
- sphinxcontrib-typerA Sphinx extension that auto-generates documentation for Typer CLI…
- alabasterAlabaster is a clean, responsive Sphinx theme for documentation that…
- sphinxcontrib-websupportProvides a Python API to integrate Sphinx-generated documentation…
Give your agent the search over MCP, or paste the wish link into any chat.
More Python Modules packages
Converts domain names between Unicode and ASCII-compatible encoding (Punycode) according to IDNA 2008 and Unicode Technical Standard 46, with security validation and broader script coverage than the standard library.
Install it if you work with internationalized domain names, need to validate domains, or use HTTP clients that depend on it transitively.
Setuptools is a Python build backend and package management tool that handles building, distributing, and installing Python packages, including support for C/C++ extension modules.
PyYAML parses and emits YAML 1.1 data format, enabling serialization and deserialization of configuration files and Python objects to and from human-readable YAML text.
Pydantic validates Python data structures against type hints, coercing and checking input at runtime to ensure it matches a declared schema.
Provides reusable metadata objects for use with PEP-593 `typing.Annotated` to express common constraints like bounds, collection sizes, and predicates on types.
Install it if you use or build libraries that need to express type constraints in a standardized, inspectable way—or if you want to annotate your own types with…
Provides runtime tools to inspect and introspect Python type annotations, enabling programmatic examination of type hints at execution time.
See also sphinx-click · typer-slim · typer · typer-config · sphinx-prompt · cyclopts · sphinx_mdinclude · sphinxcontrib-programoutput · sphinxcontrib-bibtex · sphinx_tippy