diff options
| author | jason | 2015-11-17 19:07:15 -0700 |
|---|---|---|
| committer | jason | 2015-11-17 19:07:15 -0700 |
| commit | 03261b9f3d13057a3e51ca1a0df240c5fe99a751 (patch) | |
| tree | 64f3afec5df97cacd3fad1426d25ba5f875c0ad3 /docs | |
| parent | 88bb176d02ce54aa6e34ccc2e560484b60f8b1b7 (diff) | |
| download | eventmq-03261b9f3d13057a3e51ca1a0df240c5fe99a751.tar.gz eventmq-03261b9f3d13057a3e51ca1a0df240c5fe99a751.zip | |
update documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api.rst | 12 | ||||
| -rw-r--r-- | docs/contributing.rst | 8 | ||||
| -rw-r--r-- | docs/index.rst | 15 | ||||
| -rw-r--r-- | docs/jobmanager.rst | 3 | ||||
| -rw-r--r-- | docs/protocol.rst | 3 |
5 files changed, 30 insertions, 11 deletions
diff --git a/docs/api.rst b/docs/api.rst new file mode 100644 index 0000000..12ccbb2 --- /dev/null +++ b/docs/api.rst | |||
| @@ -0,0 +1,12 @@ | |||
| 1 | ################# | ||
| 2 | API Documentation | ||
| 3 | ################# | ||
| 4 | |||
| 5 | .. toctree:: | ||
| 6 | :maxdepth: 2 | ||
| 7 | |||
| 8 | jobmanager | ||
| 9 | receiver | ||
| 10 | router | ||
| 11 | sender | ||
| 12 | |||
diff --git a/docs/contributing.rst b/docs/contributing.rst new file mode 100644 index 0000000..c0a03fb --- /dev/null +++ b/docs/contributing.rst | |||
| @@ -0,0 +1,8 @@ | |||
| 1 | ####################### | ||
| 2 | Contributing to EventMQ | ||
| 3 | ####################### | ||
| 4 | |||
| 5 | .. toctree:: | ||
| 6 | :maxdepth: 1 | ||
| 7 | |||
| 8 | protocol | ||
diff --git a/docs/index.rst b/docs/index.rst index 6c9d065..da6e513 100644 --- a/docs/index.rst +++ b/docs/index.rst | |||
| @@ -1,17 +1,12 @@ | |||
| 1 | Welcome to EventMQ's documentation! | 1 | ##################### |
| 2 | =================================== | 2 | EventMQ Documentation |
| 3 | 3 | ##################### | |
| 4 | :doc:`protocol` | ||
| 5 | |||
| 6 | Contents: | ||
| 7 | 4 | ||
| 8 | .. toctree:: | 5 | .. toctree:: |
| 9 | :maxdepth: 2 | 6 | :maxdepth: 2 |
| 10 | 7 | ||
| 11 | jobmanager | 8 | api |
| 12 | receiver | 9 | contributing |
| 13 | router | ||
| 14 | sender | ||
| 15 | 10 | ||
| 16 | 11 | ||
| 17 | Indices and tables | 12 | Indices and tables |
diff --git a/docs/jobmanager.rst b/docs/jobmanager.rst new file mode 100644 index 0000000..65b439d --- /dev/null +++ b/docs/jobmanager.rst | |||
| @@ -0,0 +1,3 @@ | |||
| 1 | .. automodule:: eventmq.jobmanager | ||
| 2 | :members: | ||
| 3 | :special-members: | ||
diff --git a/docs/protocol.rst b/docs/protocol.rst index ea01cf3..d9bd9e1 100644 --- a/docs/protocol.rst +++ b/docs/protocol.rst | |||
| @@ -1,5 +1,6 @@ | |||
| 1 | ****************************** | ||
| 1 | EventMQ Protocol Specification | 2 | EventMQ Protocol Specification |
| 2 | ============================== | 3 | ****************************** |
| 3 | *The status of this document is alpha and subject to heavy change* | 4 | *The status of this document is alpha and subject to heavy change* |
| 4 | 5 | ||
| 5 | Goals | 6 | Goals |