Improve diagnostic output (#577)

* add extended version information * autodocument argparser * add spelling exception * fix docstrings * add annotations * use typing types * add test
2025-08-24 09:03:34 +00:00 · 2023-10-05 14:15:19 +02:00
parent ba0167f1fd
commit ecfeeb9b13
9 changed files with 87 additions and 11 deletions
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -43,6 +43,7 @@ extensions = [
    "sphinx.ext.graphviz",
    "sphinx.ext.inheritance_diagram",
    "sphinx.ext.imgconverter",
+    "sphinxarg.ext",
    "sphinxcontrib.datatemplates",
    "sphinxcontrib.spelling",
 ]
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -24,6 +24,7 @@ are relevant to the user of this library.
   user/printers
   user/raspi
   user/usage
+   user/cli-user
   user/barcode

 Printer profiles
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -11,5 +11,6 @@ python-barcode>=0.11.0,<1
 importlib-metadata
 importlib_resources
 sphinxcontrib.datatemplates
+sphinx-argparse
 sphinx-autodoc-typehints
 pycups
--- a/doc/spelling_wordlist.txt
+++ b/doc/spelling_wordlist.txt
@@ -89,6 +89,7 @@ ean
 Ean
 encodable
 fff
+fullimage
 io
 json
 latin
--- a/doc/user/cli-user.rst
+++ b/doc/user/cli-user.rst
@@ -0,0 +1,10 @@
+CLI
+===
+
+:Last Reviewed: 2023-09-25
+
+Documentation of the command line interface, callable with ``python-escpos``.
+
+.. argparse::
+   :ref: escpos.cli.generate_parser
+   :prog: python-escpos