docs: REST API chapter

* Adds a new REST API chapter to the documentation. Signed-off-by: Tibor Simko <tibor.simko@cern.ch>
reanahub · Feb 7, 2017 · dbbe595 · dbbe595
1 parent eeba246
commit dbbe595
Show file tree

Hide file tree

Showing 5 changed files with 11 additions and 1 deletion.
diff --git a/docs/conf.py b/docs/conf.py
@@ -46,6 +46,7 @@
     'sphinx.ext.graphviz',
     'sphinx.ext.intersphinx',
     'sphinx.ext.viewcode',
+    'sphinxcontrib.httpdomain',
 ]
 
 # Add any paths that contain templates here, relative to this directory.

diff --git a/docs/index.rst b/docs/index.rst
@@ -6,6 +6,7 @@
 
    introduction
    gettingstarted
+   restapi
    contributing
    changes
    license

diff --git a/docs/restapi.rst b/docs/restapi.rst
@@ -0,0 +1,7 @@
+REST API
+========
+
+POST /yadage
+------------
+
+.. autofunction:: reana_workflow_controller.app.yadage_endpoint
diff --git a/reana_workflow_controller/app.py b/reana_workflow_controller/app.py
@@ -28,7 +28,7 @@
 import traceback
 
 from flask import Flask, abort, jsonify, redirect, request
-from tasks import run_yadage_workflow
+from .tasks import run_yadage_workflow
 
 app = Flask(__name__)
 app.secret_key = "super secret key"

diff --git a/setup.py b/setup.py
@@ -47,6 +47,7 @@
     'docs': [
         'Sphinx>=1.4.4',
         'sphinx-rtd-theme>=0.1.9',
+        'sphinxcontrib-httpdomain>=1.5.0',
     ],
     'tests': tests_require,
 }