update documentation

docs/conf.py

@@ -18,7 +18,9 @@ import os
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+DOC_DIR  = os.path.dirname(__file__)
+ROOT_DIR = os.path.dirname(DOC_DIR)
+sys.path.insert(0, ROOT_DIR)
 
 # -- General configuration ------------------------------------------------
 

docs/index.rst

@@ -139,9 +139,6 @@ Technical Documentation
 
 We open to everyone for contribute in this project. Please refer `Communication_protocol_manual_CMD.pdf <https://github.com/fananimi/pyzk/blob/master/docs/_static/Communication_protocol_manual_CMD.pdf>`_ before you starting write your code.
 
-.. toctree::
-   :maxdepth: 2
-
 
 Indices and tables
 ##################
@@ -149,3 +146,4 @@ Indices and tables
 * :ref:`genindex`
 * :ref:`modindex`
 * :ref:`search`
+

docs/modules.rst

@@ -1,7 +0,0 @@
-zk
-==
-
-.. toctree::
-   :maxdepth: 4
-
-   zk

docs/zk.rst

@@ -1,38 +0,0 @@
-zk package
-==========
-
-Submodules
-----------
-
-zk.base module
---------------
-
-.. automodule:: zk.base
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-zk.const module
----------------
-
-.. automodule:: zk.const
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-zk.user module
---------------
-
-.. automodule:: zk.user
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-
-Module contents
----------------
-
-.. automodule:: zk
-    :members:
-    :undoc-members:
-    :show-inheritance:

docs/zk_attendance.rst

@@ -0,0 +1,12 @@
+zk attendance
+=============
+
+
+zk.attendance
+-------------
+
+.. automodule:: zk.attendance
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/zk_base.rst

@@ -0,0 +1,11 @@
+zk base
+=======
+
+zk.base module
+--------------
+
+.. automodule:: zk.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/zk_const.rst

@@ -0,0 +1,12 @@
+zk const
+========
+
+
+zk.const module
+---------------
+
+.. automodule:: zk.const
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/zk_exception.rst

@@ -0,0 +1,11 @@
+zk exception
+============
+
+zk.exception
+------------
+
+.. automodule:: zk.exception
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/zk_finger.rst

@@ -0,0 +1,12 @@
+zk finger
+=========
+
+
+zk.finger
+---------
+
+.. automodule:: zk.finger
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/zk_user.rst

@@ -0,0 +1,12 @@
+zk user
+=======
+
+
+zk.user module
+---------------
+
+.. automodule:: zk.user
+    :members:
+    :undoc-members:
+    :show-inheritance:
+