update documentation

This commit is contained in:
Fanani M. Ihsan 2018-12-29 09:34:14 +07:00
parent 8d41a427d1
commit b28bfef7d7
8 changed files with 111 additions and 5 deletions

View File

@ -0,0 +1,8 @@
.. toctree::
:caption: Compatible Device
:name: compatible_devices
##################
Compatible Devices
##################

View File

@ -112,7 +112,7 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # 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 # 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 # further. For a list of options available for each theme, see the

View File

@ -3,17 +3,32 @@
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive. 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! 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 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 You can install from two different options
@ -24,7 +39,7 @@ You can install from two different options
2. from original repository 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 <//github.com/fananimi/pyzk>`_ then clone the latest source code by using git, and then just execute the setup.py file.
``$ python setup.py install`` ``$ python setup.py install``

14
docs/topic1.rst Normal file
View File

@ -0,0 +1,14 @@
.. toctree::
:caption: Connect / Disconnect to Machine
:name: topic1
###############################
Connect / Disconnect to Machine
###############################
Connect
-------
Disconnect
----------

20
docs/topic2.rst Normal file
View File

@ -0,0 +1,20 @@
.. toctree::
:caption: User Operation
:name: topic2
##############
User Operation
##############
Create User
-----------
Enroll User
-----------
Update User
-----------
Delete User
-----------

15
docs/topic3.rst Normal file
View File

@ -0,0 +1,15 @@
.. toctree::
:caption: Attendance Log Operation
:name: topic3
########################
Attendance Log Operation
########################
Get Attendance Log
------------------
Clear Attendance Log
--------------------

23
docs/topic4.rst Normal file
View File

@ -0,0 +1,23 @@
.. toctree::
:caption: Device maintenance
:name: topic4
##################
Device Maintenance
##################
Set Time
--------
Poweroff
--------
Restart
-------
Clear Buffer
------------
Clear Data
-----------

11
docs/topic5.rst Normal file
View File

@ -0,0 +1,11 @@
.. toctree::
:caption: IOT
:name: topic5
###
IOT
###
Door Lock Open
-------------