add png conversion

sphinx-contrib · Dec 17, 2023 · 7aeced5 · 7aeced5
1 parent acce413
commit 7aeced5
Show file tree

Hide file tree

Showing 3 changed files with 203 additions and 94 deletions.
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -13,7 +13,7 @@ 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
-============
+------------
 
 Install with pip::
 
@@ -36,7 +36,7 @@ Add ``sphinxcontrib.typer`` to your ``conf.py`` file:
     ]
 
 Usage
-=====
+-----
 
 Say you have a command in the file ``examples/example.py`` that looks like
 this:
@@ -61,13 +61,15 @@ This would generate html that looks like this:
    :prog: example
    :width: 70
    :preferred: html
+   :convert-png: latex
 
 
 You could change ``:preferred:`` to svg, to generate svg instead:
 
 .. typer:: examples.example.app
    :prog: example
    :preferred: svg
+   :convert-png: latex
 
 |
 
@@ -77,6 +79,7 @@ Or to text:
    :prog: example
    :preferred: text
    :width: 93
+   :convert-png: latex
 
 
 The ``typer`` directive has options for generating docs for all subcommands as

diff --git a/example.html.png b/example.html.png