DOC improve the documentation

* make API-doc more legible
* improve comments in methods

doc/api.rst

@@ -1,46 +0,0 @@
-escpos package
-==============
-
-Submodules
-----------
-
-escpos.constants module
------------------------
-
-.. automodule:: escpos.constants
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-escpos.escpos module
---------------------
-
-.. automodule:: escpos.escpos
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-escpos.exceptions module
-------------------------
-
-.. automodule:: escpos.exceptions
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-escpos.printer module
----------------------
-
-.. automodule:: escpos.printer
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: escpos
-    :members:
-    :undoc-members:
-    :show-inheritance:

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

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

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

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

doc/index.rst

@@ -25,8 +25,8 @@ sending my PayPal info so you can donate.
 
 Thank you!
 
-User Documentation:
--------------------
+User Documentation
+------------------
 
 .. toctree::
    :maxdepth: 1
@@ -39,13 +39,16 @@ User Documentation:
    user/todo
    user/usage
 
-API:
-----
+API
+---
 
 .. toctree::
    :maxdepth: 1
    
-   api
+   api/escpos
+   api/printer
+   api/constants
+   api/exceptions
 
 Indices and tables
 ==================

doc/user/methods.rst

@@ -2,7 +2,8 @@
 Methods
 *******
 
-.. note:: **TODO** Merge this page into the API-description.
+.. note:: **TODO** Merge this page with the API-description. (Make the API-description more pretty and then
+          replace this with the API-description.)
 
 Escpos class
 ------------

doc/user/todo.rst

@@ -21,6 +21,7 @@ Testing
 ~~~~~~~
 
 * Test on many printers as possible (USB, Serial, Network)
+* automate testing
 
 Design
 ~~~~~~
@@ -32,4 +33,6 @@ Design
   *  Windows compatibility (hidapi instead libusb?)
   *  PDF417 support
 
+* use something similar to the `capabilities` in escpos-php
+