diff options
Diffstat (limited to 'docs/index.rst')
| -rw-r--r-- | docs/index.rst | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..d52b808 --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,33 @@ +.. taskthread documentation master file, created by + sphinx-quickstart on Wed Dec 4 15:35:14 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to taskthread's documentation! +====================================== + +*taskthread* provides a thread implementation that executes a repetitive +task several times without the need to start up a new thread. + +Installation +------------ + +*taskthread* can be installed with pip, via ``pip install taskthread``. + +Usage +----- + +TaskThread +~~~~~~~~~~ +.. autoclass:: taskthread.TaskThread + :members: + +TaskInProcessException +~~~~~~~~~~~~~~~~~~~~~~ +.. autoclass:: taskthread.TaskInProcessException + :members: + +TimerThread +~~~~~~~~~~~~~~~~~~~~~~ +.. autoclass:: taskthread.TimerTask + :members: |