Merge branch 'feature/background-task' into develop

README.md

@@ -19,9 +19,9 @@ A helper library in Python for authors of workflows for [Alfred 2](http://www.al
 
 ## Installation ##
 
-1. Download the `alfred-workflow-x.x.zip` from the [releases page](https://github.com/deanishe/alfred-workflow/releases).
+1. Download the `alfred-workflow-X.X.zip` from the [releases page](https://github.com/deanishe/alfred-workflow/releases).
 2. Either extract the ZIP archive and place the `workflow` directory in the root folder of your workflow (where `info.plist` is) **or**
-3. Place the ZIP archive in the root folder of your workflow and add `sys.path.insert(0, 'alfred-workflow-x.x.zip')` at the top of your Python script(s).
+3. Place the ZIP archive in the root folder of your workflow and add `sys.path.insert(0, 'alfred-workflow-X.X.zip')` at the top of your Python script(s).
 
 Your workflow should look something like this:
 
@@ -30,6 +30,7 @@ Your workflow should look something like this:
         icon.png
         workflow/
             __init__.py
+            background.py
             workflow.py
             web.py
         yourscript.py

build-docs.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+basedir=$(cd $(dirname $0); pwd)
+docdir=${basedir}/doc
+curdir=$(pwd)
+
+cd "${docdir}"
+make html
+cd "${curdir}"

doc/background.rst

@@ -0,0 +1,8 @@
+workflow.background
+-----------------
+
+.. automodule:: workflow.background
+    :members: run_in_background, is_running
+    :undoc-members:
+    :show-inheritance:
+

doc/index.rst

@@ -69,6 +69,7 @@ Documentation automatically generated from the source code.
 
    workflow
    web
+   background
 
 
 Indices and tables