From b28bfef7d7e84da2c6c190385beb750f99e967ef Mon Sep 17 00:00:00 2001 From: "Fanani M. Ihsan" Date: Sat, 29 Dec 2018 09:34:14 +0700 Subject: [PATCH] update documentation --- docs/compatible_devices.rst | 8 ++++++++ docs/conf.py | 2 +- docs/index.rst | 23 +++++++++++++++++++---- docs/topic1.rst | 14 ++++++++++++++ docs/topic2.rst | 20 ++++++++++++++++++++ docs/topic3.rst | 15 +++++++++++++++ docs/topic4.rst | 23 +++++++++++++++++++++++ docs/topic5.rst | 11 +++++++++++ 8 files changed, 111 insertions(+), 5 deletions(-) create mode 100644 docs/compatible_devices.rst create mode 100644 docs/topic1.rst create mode 100644 docs/topic2.rst create mode 100644 docs/topic3.rst create mode 100644 docs/topic4.rst create mode 100644 docs/topic5.rst diff --git a/docs/compatible_devices.rst b/docs/compatible_devices.rst new file mode 100644 index 0000000..29a002d --- /dev/null +++ b/docs/compatible_devices.rst @@ -0,0 +1,8 @@ +.. toctree:: + :caption: Compatible Device + :name: compatible_devices + +################## +Compatible Devices +################## + diff --git a/docs/conf.py b/docs/conf.py index 5ba88ce..b25d218 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -112,7 +112,7 @@ todo_include_todos = False # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'alabaster' +html_theme = 'classic' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the diff --git a/docs/index.rst b/docs/index.rst index c7adc75..e4f6e4a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,17 +3,32 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +.. toctree:: + :hidden: + :maxdepth: 4 + :caption: Home Page + :name: index + + topic1 + topic2 + topic3 + topic4 + topic5 + compatible_devices + + ******************************** Welcome to pyzk's documentation! ******************************** -pyzk is an unofficial library of zksoftware the fingerprint attendance machine. It's easy to use and no need to understand how to communicate to device. Just create ZK instance and you will ready to use api. +pyzk is an unofficial library of zksoftware (zkzteco family) the fingerprint attendance machine. It's easy to use and no need to understand how to communicate to device. + +.. image:: https://travis-ci.org/fananimi/pyzk.svg?branch=master + :target: https://travis-ci.org/fananimi/pyzk Installation ############ -.. image:: https://travis-ci.org/fananimi/pyzk.svg?branch=master - :target: https://travis-ci.org/fananimi/pyzk You can install from two different options @@ -24,7 +39,7 @@ You can install from two different options 2. from original repository -Go to https://github.com/fananimi/pyzk and clone the latest source code by using git, and then just execute the setup.py file. +Go to `repository `_ then clone the latest source code by using git, and then just execute the setup.py file. ``$ python setup.py install`` diff --git a/docs/topic1.rst b/docs/topic1.rst new file mode 100644 index 0000000..3b6b5f7 --- /dev/null +++ b/docs/topic1.rst @@ -0,0 +1,14 @@ +.. toctree:: + :caption: Connect / Disconnect to Machine + :name: topic1 + +############################### +Connect / Disconnect to Machine +############################### + +Connect +------- + +Disconnect +---------- + diff --git a/docs/topic2.rst b/docs/topic2.rst new file mode 100644 index 0000000..024e8cd --- /dev/null +++ b/docs/topic2.rst @@ -0,0 +1,20 @@ +.. toctree:: + :caption: User Operation + :name: topic2 + +############## +User Operation +############## + +Create User +----------- + +Enroll User +----------- + +Update User +----------- + +Delete User +----------- + diff --git a/docs/topic3.rst b/docs/topic3.rst new file mode 100644 index 0000000..f87aff8 --- /dev/null +++ b/docs/topic3.rst @@ -0,0 +1,15 @@ +.. toctree:: + :caption: Attendance Log Operation + :name: topic3 + +######################## +Attendance Log Operation +######################## + + +Get Attendance Log +------------------ + +Clear Attendance Log +-------------------- + diff --git a/docs/topic4.rst b/docs/topic4.rst new file mode 100644 index 0000000..b359c18 --- /dev/null +++ b/docs/topic4.rst @@ -0,0 +1,23 @@ +.. toctree:: + :caption: Device maintenance + :name: topic4 + +################## +Device Maintenance +################## + +Set Time +-------- + +Poweroff +-------- + +Restart +------- + +Clear Buffer +------------ + +Clear Data +----------- + diff --git a/docs/topic5.rst b/docs/topic5.rst new file mode 100644 index 0000000..15d3091 --- /dev/null +++ b/docs/topic5.rst @@ -0,0 +1,11 @@ +.. toctree:: + :caption: IOT + :name: topic5 + +### +IOT +### + +Door Lock Open +------------- +