aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorjason2016-12-08 16:00:41 -0700
committerjason2016-12-08 17:45:59 -0700
commit5863a59c929e9de399e57af1eafa812c0467dcc8 (patch)
tree217e3aa8b8a9e9e64e9886c9ef5ece5048c4e866 /docs
parentdc3abf44410d770a503cb215db16e43035d285c1 (diff)
downloadeventmq-5863a59c929e9de399e57af1eafa812c0467dcc8.tar.gz
eventmq-5863a59c929e9de399e57af1eafa812c0467dcc8.zip
Adds job decorator for deferring jobs
- adds eventmq.client.jobs.job and Job() to be used as a decorator for deferring functions - add example usage to README - add client env variable `EMQ_BROKER_ADDR` to easily specify where the broker is for deferring jobs.
Diffstat (limited to 'docs')
-rw-r--r--docs/client/jobs.rst3
-rw-r--r--docs/settings_file.rst6
-rw-r--r--docs/using.rst6
3 files changed, 12 insertions, 3 deletions
diff --git a/docs/client/jobs.rst b/docs/client/jobs.rst
new file mode 100644
index 0000000..a4acb3b
--- /dev/null
+++ b/docs/client/jobs.rst
@@ -0,0 +1,3 @@
1.. automodule:: eventmq.client.jobs
2 :members:
3 :special-members:
diff --git a/docs/settings_file.rst b/docs/settings_file.rst
index b0bc36c..cd37b6a 100644
--- a/docs/settings_file.rst
+++ b/docs/settings_file.rst
@@ -1,6 +1,6 @@
1######## 1##############################
2Settings 2Server Settings (eventmq.conf)
3######## 3##############################
4EventMQ uses a standard INI style config file found at ``/etc/eventmq.conf``. 4EventMQ uses a standard INI style config file found at ``/etc/eventmq.conf``.
5 5
6****** 6******
diff --git a/docs/using.rst b/docs/using.rst
index 3c6a517..4e5ee10 100644
--- a/docs/using.rst
+++ b/docs/using.rst
@@ -6,3 +6,9 @@ Using EventMQ
6 :maxdepth: 2 6 :maxdepth: 2
7 7
8 settings_file 8 settings_file
9
10****************************
11Client Environment Variables
12****************************
13
14``EMQ_BROKER_ADDR`` is the address a client should use to connect to the broker. The client can be any application using EventMQ.