docs: autoload client methods and add missing parameter descriptions

Configure Sphinx to autoload all the public methods from `api.client`
and add a small descriptions of the parameters and return value of a
function where it was missing.

Closes reanahub#665.

docs/conf.py

@@ -24,6 +24,9 @@
 from __future__ import print_function
 
 import os
+import sys
+
+from unittest.mock import Mock
 
 import sphinx.environment
 
@@ -33,6 +36,11 @@
 #
 # needs_sphinx = '1.0'
 
+# Manually mock the modules to connect to the REANA server API.
+# Note that autodoc_mock_imports does not work.
+MOCK_MODULES = ["reana_commons.api_client"]
+sys.modules.update((mod_name, Mock()) for mod_name in MOCK_MODULES)
+
 # Do not warn on external images.
 suppress_warnings = ["image.nonlocal_uri"]
 

docs/index.rst

@@ -21,7 +21,7 @@ API docs
 ========
 
 .. automodule:: reana_client.api.client
-  :members: create_workflow_from_json, upload_to_server, upload_file, start_workflow, list_files, get_workflow_status, download_file, get_workflow_logs
+  :members:
 
 .. include:: ../CHANGES.rst