Skip to content
Back to top
View this page
Edit this page

# sphinxcontrib-typer

A Sphinx directive for auto generating docs for Typer (and Click commands!) using the rich console formatting available in Typer. This package generates concise command documentation in text, html or svg formats out of the box, but if your goal is to greatly customize the generated documentation sphinx-click:index may be more appropriate and will also work for Typer commands.

See the github repository for issue tracking and source code and install from sphinxcontrib-typer with `pip install sphinxcontrib-typer`.

For example, commands and subcommands are renderable separately in four different formats:

- svg

- html

- text

- png

     Usage: example ARG:{one|two} bar [OPTIONS]

     This is the bar command.

    ╭─ Options ────────────────────────────────────────────────────────────────────────────────╮
    │ *  --names        TEXT  The names of the items to bar. [required]                        │
    │    --help               Show this message and exit.                                      │
    ╰──────────────────────────────────────────────────────────────────────────────────────────╯

The `typer` directive has options for generating docs for all subcommands as well and optionally generating independent sections for each. There are also mechanisms for passing options to the underlying console and svg generation functions. See table of contents for more information.

Contents:

- Installation
- How To
  - Build to Multiple Formats
  - Change the Width
  - Render Subcommand Structure
    - example
  - Render a Single Subcommand
    - example bar
  - Render as HTML
  - Generate Nice PDFs
  - Customize the Rendered Output
  - Cross-Reference with :make-sections:
- Themes
  - Light (default)
  - Dark
  - Monokai
  - Dimmed Monokai
  - Night Owlish
  - Red Sands
  - Blue Waves
- Reference
  - Directives
    - `.. typer::`
  - Configuration
    - Configuration Attributes
    - Function Hooks
  - Roles
- Change Log
  - v0.8.0 (2026-02-12)
  - v0.7.2 (2025-12-23)
  - v0.7.1 (2025-12-22)
  - v0.7.0 (2025-11-22)
  - v0.6.2 (2025-09-23)
  - v0.6.1 (2025-09-23)
  - v0.6.0 (2025-09-22)
  - v0.5.1 (2024-10-14)
  - v0.5.0 (2024-08-24)
  - v0.4.2 (2024-08-22)
  - v0.4.1 (2024-08-22)
  - v0.4.0 (2024-08-19)
  - v0.3.5 (2024-08-17)
  - v0.3.4 (2024-08-15)
  - v0.3.3 (2024-07-15)
  - v0.3.2 (yanked)
  - v0.3.1 (2024-06-11)
  - v0.3.0 (2024-06-01)
  - v0.2.5 (2024-05-29)
  - v0.2.4 (2024-05-29)
  - v0.2.3 (2024-05-22)
  - v0.2.2 (2024-05-14)
  - v0.2.1 (2024-04-11)
  - v0.2.0 (2024-04-03)
  - v0.1.12 (2024-03-05)
  - v0.1.11 (2024-02-22)
  - v0.1.10 (2024-02-21)
  - v0.1.9 (2024-02-21)
  - v0.1.8 (2024-02-20)
  - v0.1.7 (2024-01-31)
  - v0.1.6 (2024-01-31)
  - v0.1.5 (2024-01-30)
  - v0.1.4 (2023-12-21)
  - v0.1.3 (2023-12-19)
  - v0.1.2 (2023-12-19)
  - v0.1.1 (2023-12-19)
  - v0.1.0 (2023-12-19)