From bf4d466c75c00f3f8d92e0a8973900374f29e901 Mon Sep 17 00:00:00 2001 From: jason Date: Tue, 17 Nov 2015 19:07:58 -0700 Subject: update documentation --- .gitignore | 1 + _sources/api.txt | 12 +++ _sources/contributing.txt | 8 ++ _sources/index.txt | 15 ++-- _sources/protocol.txt | 3 +- api.html | 217 ++++++++++++++++++++++++++++++++++++++++++++++ contributing.html | 211 ++++++++++++++++++++++++++++++++++++++++++++ genindex.html | 6 +- index.html | 39 +++++---- protocol.html | 57 ++++++++---- py-modindex.html | 6 +- search.html | 6 +- searchindex.js | 2 +- 13 files changed, 525 insertions(+), 58 deletions(-) create mode 100644 .gitignore create mode 100644 _sources/api.txt create mode 100644 _sources/contributing.txt create mode 100644 api.html create mode 100644 contributing.html diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..106a152 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.buildinfo diff --git a/_sources/api.txt b/_sources/api.txt new file mode 100644 index 0000000..12ccbb2 --- /dev/null +++ b/_sources/api.txt @@ -0,0 +1,12 @@ +################# +API Documentation +################# + +.. toctree:: + :maxdepth: 2 + + jobmanager + receiver + router + sender + diff --git a/_sources/contributing.txt b/_sources/contributing.txt new file mode 100644 index 0000000..c0a03fb --- /dev/null +++ b/_sources/contributing.txt @@ -0,0 +1,8 @@ +####################### +Contributing to EventMQ +####################### + +.. toctree:: + :maxdepth: 1 + + protocol diff --git a/_sources/index.txt b/_sources/index.txt index 6c9d065..da6e513 100644 --- a/_sources/index.txt +++ b/_sources/index.txt @@ -1,17 +1,12 @@ -Welcome to EventMQ's documentation! -=================================== - -:doc:`protocol` - -Contents: +##################### +EventMQ Documentation +##################### .. toctree:: :maxdepth: 2 - jobmanager - receiver - router - sender + api + contributing Indices and tables diff --git a/_sources/protocol.txt b/_sources/protocol.txt index ea01cf3..d9bd9e1 100644 --- a/_sources/protocol.txt +++ b/_sources/protocol.txt @@ -1,5 +1,6 @@ +****************************** EventMQ Protocol Specification -============================== +****************************** *The status of this document is alpha and subject to heavy change* Goals diff --git a/api.html b/api.html new file mode 100644 index 0000000..e04493c --- /dev/null +++ b/api.html @@ -0,0 +1,217 @@ + + + + + + + + + + + API Documentation — EventMQ 0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+ +
+
+
+ +
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/contributing.html b/contributing.html new file mode 100644 index 0000000..e9cae5d --- /dev/null +++ b/contributing.html @@ -0,0 +1,211 @@ + + + + + + + + + + + Contributing to EventMQ — EventMQ 0 documentation + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + +
+ + + + + + +
+
+ + + + + + +
+ +
+
+
+
+ +
+

Contributing to EventMQ

+
+ +
+
+ + +
+
+ + +
+
+ +
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/genindex.html b/genindex.html index cf9659f..13c01a8 100644 --- a/genindex.html +++ b/genindex.html @@ -81,10 +81,8 @@ diff --git a/index.html b/index.html index 2b3f962..2e2f22c 100644 --- a/index.html +++ b/index.html @@ -8,7 +8,7 @@ - Welcome to EventMQ’s documentation! — EventMQ 0 documentation + EventMQ Documentation — EventMQ 0 documentation @@ -31,7 +31,7 @@ - + @@ -81,10 +81,8 @@ @@ -115,7 +113,7 @@