Skip to content

Commit

Permalink
fix example svg
Browse files Browse the repository at this point in the history
  • Loading branch information
bckohan committed Dec 16, 2023
1 parent eaee37d commit acce413
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 86 deletions.
12 changes: 6 additions & 6 deletions doc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ 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
beautiful command documentation in text, html or svg formats out of the box,
but if your goal is to greatly customize the generated documentation
but if your goal is to greatly customize the generated documentation
sphinx-click_ may be more appropriate and will also work for Typer_ commands.

Installation
Expand All @@ -27,7 +27,7 @@ Add ``sphinxcontrib.typer`` to your ``conf.py`` file:
# 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'))
sys.path.insert(0, str(Path(__file__).parent / 'path/to/your/commands'))
extensions = [
...
Expand Down Expand Up @@ -79,10 +79,10 @@ Or to text:
:width: 93


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.
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.

.. toctree::
:maxdepth: 2
Expand Down
Loading

0 comments on commit acce413

Please sign in to comment.