From acce413abc7f1b64d2efd84a25317aea74f2257f Mon Sep 17 00:00:00 2001 From: Brian Kohan Date: Sat, 16 Dec 2023 13:29:23 -0800 Subject: [PATCH] fix example svg --- doc/source/index.rst | 12 ++-- example.svg | 160 +++++++++++++++++++++---------------------- 2 files changed, 86 insertions(+), 86 deletions(-) diff --git a/doc/source/index.rst b/doc/source/index.rst index 4e77150..68ecd1f 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 @@ -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 = [ ... @@ -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 diff --git a/example.svg b/example.svg index 2be3a55..c2d8917 100644 --- a/example.svg +++ b/example.svg @@ -1,4 +1,4 @@ - + + .terminal-1973473189-r1 { fill: #c5c8c6;font-weight: bold } +.terminal-1973473189-r2 { fill: #c5c8c6 } +.terminal-1973473189-r3 { fill: #d0b344;font-weight: bold } +.terminal-1973473189-r4 { fill: #868887 } +.terminal-1973473189-r5 { fill: #68a0b3;font-weight: bold } +.terminal-1973473189-r6 { fill: #98729f;font-weight: bold } + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - example - - - - - - - + example + + + + + - - - Usage: example [OPTIONS] COMMAND [ARGS]... - - This is the callback function. - - ╭─ Options ────────────────────────────────────────────────────────────────────╮ - │--flag1--no-flag1Flag 1.[default: no-flag1]│ - │--flag2--no-flag2Flag 2.[default: no-flag2]│ - │--helpShow this message and exit.│ - ╰──────────────────────────────────────────────────────────────────────────────╯ - ╭─ Commands ───────────────────────────────────────────────────────────────────╮ - │bar       This is the bar command.                                        │ - │foo       This is the foo command.                                        │ - ╰──────────────────────────────────────────────────────────────────────────────╯ - - - + + + + +Usage: example [OPTIONS] COMMAND [ARGS]... + +This is the callback function. + +╭─ Options ──────────────────────────────────────────────────────────╮ +│--flag1--no-flag1Flag 1.[default: no-flag1]│ +│--flag2--no-flag2Flag 2.[default: no-flag2]│ +│--helpShow this message and exit.│ +╰────────────────────────────────────────────────────────────────────╯ +╭─ Commands ─────────────────────────────────────────────────────────╮ +│bar      This is the bar command.                               │ +│foo      This is the foo command.                               │ +╰────────────────────────────────────────────────────────────────────╯ + + +