https://github.com/sphinx-contrib/typer
Auto generate docs for typer and click commands using typer's rich console formatting.
https://github.com/sphinx-contrib/typer
autodoc click command-line help python sphinx-doc typer
Last synced: 7 days ago
JSON representation
Auto generate docs for typer and click commands using typer's rich console formatting.
- Host: GitHub
- URL: https://github.com/sphinx-contrib/typer
- Owner: sphinx-contrib
- License: mit
- Created: 2023-12-12T21:41:28.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-28T20:13:38.000Z (3 months ago)
- Last Synced: 2025-04-25T19:17:42.247Z (15 days ago)
- Topics: autodoc, click, command-line, help, python, sphinx-doc, typer
- Language: Python
- Homepage: https://sphinxcontrib-typer.rtfd.io
- Size: 562 KB
- Stars: 17
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://opensource.org/licenses/MIT)
[](https://pypi.python.org/pypi/sphinxcontrib-typer/)
[](https://pypi.python.org/pypi/sphinxcontrib-typer/)
[](https://pypi.python.org/pypi/sphinxcontrib-typer)
[](http://sphinxcontrib-typer.readthedocs.io/?badge=latest/)
[](https://app.codecov.io/gh/sphinx-contrib/typer)
[](https://github.com/sphinx-contrib/typer/actions/workflows/test.yml)
[](https://github.com/sphinx-contrib/typer/actions/workflows/lint.yml)
[](https://github.com/astral-sh/ruff)
# sphinxcontrib-typer
A Sphinx directive for auto generating docs for [Typer](https://typer.tiangolo.com/)
(and [Click](https://click.palletsprojects.com/) commands!) using the rich console
formatting available in [Typer](https://typer.tiangolo.com/). 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](https://sphinx-click.readthedocs.io/en/latest/) may be more appropriate
and will also work for [Typer](https://typer.tiangolo.com/) commands.
## Installation
Install with pip::
pip install sphinxcontrib-typer
Add ``sphinxcontrib.typer`` to your ``conf.py`` file:
```python
# be sure that the commands you want to document are importable
# from the python path when building the docs
import sys
from pathlib import Path
sys.path.insert(0, str(Path(__file__).parent / '../path/to/your/commands'))
extensions = [
...
'sphinxcontrib.typer',
...
]
```
## Usage
Say you have a command in the file ``examples/example.py`` that looks like
this:
```python
import typer
import typing as t
app = typer.Typer(add_completion=False)
@app.callback()
def callback(
flag1: bool = typer.Option(False, help="Flag 1."),
flag2: bool = typer.Option(False, help="Flag 2.")
):
"""This is the callback function."""
pass
@app.command()
def foo(
name: str = typer.Option(..., help="The name of the item to foo.")
):
"""This is the foo command."""
pass
@app.command()
def bar(
names: t.List[str] = typer.Option(..., help="The names of the items to bar."),
):
"""This is the bar command."""
pass
if __name__ == "__main__":
app()
```
You can generate documentation for this command using the ``typer`` directive
like so:
```rst
.. typer:: examples.example.app
:prog: example1
:width: 70
:preferred: html
```
This would generate html that looks like this:
You could change ``:preferred:`` to svg, to generate svg instead:
|
Or to text
Usage: example [OPTIONS] COMMAND [ARGS]...
This is the callback function.
╭─ Options ──────────────────────────────────────────────────────────╮
│ --flag1 --no-flag1 Flag 1. [default: no-flag1] │
│ --flag2 --no-flag2 Flag 2. [default: no-flag2] │
│ --help Show this message and exit. │
╰────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────╮
│ bar This is the bar command. │
│ foo This is the foo command. │
╰────────────────────────────────────────────────────────────────────╯
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 the
official documentation for more information.