diff options
| author | James E. Blair <jeblair@openstack.org> | 2013-04-08 15:17:42 -0700 |
|---|---|---|
| committer | James E. Blair <jeblair@openstack.org> | 2013-04-10 14:06:18 -0700 |
| commit | ba9ff1c9c6c91258ec7960a2eb92d80a7d5f0369 (patch) | |
| tree | 7f0cb851a219a9f1d4e3dea5c9fb24a49428fec5 /doc/source/index.rst | |
| parent | 8a8b7ffab0f53a4e4c0890912fe034a9583f40c9 (diff) | |
| download | gear-ba9ff1c9c6c91258ec7960a2eb92d80a7d5f0369.tar.gz | |
Add Sphinx documentation.
Add more events.
Also, return Job objects from event handlers for convenience of
subclasses.
Add sphinx config to setup.cfg.
Change-Id: I2ccc32fbc5f043a67d5da86cc3c37ab3d2c30d99
Diffstat (limited to 'doc/source/index.rst')
| -rw-r--r-- | doc/source/index.rst | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..c5971af --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,21 @@ +.. Gear documentation master file, created by + sphinx-quickstart on Mon Apr 8 15:28:36 2013. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Gear: Asynchronous Event-Driven Gearman Interface +================================================= + +.. automodule:: gear + :members: + +.. automodule:: gear.constants + :members: + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + |