DOC improve the documentation

* make API-doc more legible * improve comments in methods
2025-08-24 09:03:34 +00:00 · 2016-01-05 17:30:40 +01:00
parent e5cd37bfbc
commit 8b8ca76af6
12 changed files with 289 additions and 132 deletions
--- a/doc/api/constants.rst
+++ b/doc/api/constants.rst
@@ -0,0 +1,10 @@
+Constants
+---------
+Module :py:mod:`escpos.constants`
+
+.. automodule:: escpos.constants
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource
--- a/doc/api/escpos.rst
+++ b/doc/api/escpos.rst
@@ -0,0 +1,10 @@
+Esc/Pos
+-------
+Module :py:mod:`escpos.escpos`
+
+.. automodule:: escpos.escpos
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource
--- a/doc/api/exceptions.rst
+++ b/doc/api/exceptions.rst
@@ -0,0 +1,9 @@
+Exceptions
+----------
+Module :py:mod:`escpos.exceptions`
+
+.. automodule:: escpos.exceptions
+    :members:
+    :inherited-members:
+    :show-inheritance:
+    :member-order: bysource
--- a/doc/api/printer.rst
+++ b/doc/api/printer.rst
@@ -0,0 +1,10 @@
+Printer implementations
+-----------------------
+Module :py:mod:`escpos.printer`
+
+.. automodule:: escpos.printer
+    :members:
+    :inherited-members:
+    :undoc-members:
+    :show-inheritance:
+    :member-order: bysource