make automodule docs

2016-05-27 00:52:50 +07:00 · 2016-05-27 00:52:50 +07:00 · baf672bcb9
parent dc493e8d7e
commit baf672bcb9
3 changed files with 45 additions and 11 deletions
--- a/docs/modules.rst
+++ b/docs/modules.rst
@ -0,0 +1,7 @@
+zk
+==
+
+.. toctree::
+   :maxdepth: 4
+
+   zk
--- a/docs/zk.rst
+++ b/docs/zk.rst
@ -0,0 +1,38 @@
+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:
--- a/zk/const.py
+++ b/zk/const.py
@ -95,14 +95,3 @@ EF_ALARM            = (1<<9)# Alarm signal

 USER_DEFAULT        = 0
 USER_ADMIN          = 14
-
-'''
-Follow is data type sign (attendance record, fingerprint)
-FCT_ATTLOG      (U8)1   Attendance record
-FCT_WORKCODE    (U8)8   WorkCode。
-FCT_FINGERTMP   (U8)2   Fingerprint data
-FCT_OPLOG       (U8)4   Operation record
-FCT_USER        (U8)5   User record
-FCT_SMS         (U8)6   Short message
-FCT_UDATA       (U8)7   User’s short message
-'''