From 50fbf2873fa4957490866e7445eef31514c7a56b Mon Sep 17 00:00:00 2001 From: Patrick Kanzler Date: Sun, 27 Dec 2015 19:39:22 +0100 Subject: [PATCH] DOC improve api.rst --- doc/api.rst | 50 ++++++++++++++++++++++++++++++++------------------ 1 file changed, 32 insertions(+), 18 deletions(-) diff --git a/doc/api.rst b/doc/api.rst index 30d3cde..a3b00b1 100644 --- a/doc/api.rst +++ b/doc/api.rst @@ -1,32 +1,46 @@ -API reference -============= +escpos package +============== -The main class and abstract implementation of an Esc/Pos printer. +Submodules +---------- + +escpos.constants module +----------------------- + +.. automodule:: escpos.constants + :members: + :undoc-members: + :show-inheritance: + +escpos.escpos module +-------------------- -escpos -====== .. automodule:: escpos.escpos :members: :undoc-members: :show-inheritance: - -printer -======= + +escpos.exceptions module +------------------------ + +.. automodule:: escpos.exceptions + :members: + :undoc-members: + :show-inheritance: + +escpos.printer module +--------------------- + .. automodule:: escpos.printer :members: :undoc-members: :show-inheritance: -exceptions -========== -.. automodule:: escpos.exceptions + +Module contents +--------------- + +.. automodule:: escpos :members: :undoc-members: :show-inheritance: - -constants -========= -.. automodule:: escpos.constants - :members: - :undoc-members: - :show-inheritance: \ No newline at end of file