diff --git a/README_SETUP.md b/README_SETUP.md index b05eff87711b84682aa82bbd0aafd61f2e8c86eb..8a32fbfacb8fd5733c65998b35e52e1c7bbceab1 100644 --- a/README_SETUP.md +++ b/README_SETUP.md @@ -119,6 +119,7 @@ Build documentation in `build/` with `make doc`. - `sphinx` - `sphinx-autoapi` - `recommonmark` +- `sphinx_rtd_theme` ### How to contribute ### diff --git a/src/linkahead/utils/server_side_scripting.py b/src/linkahead/utils/server_side_scripting.py index 06caa3d94a629e368dc99f83dc2957c756b7b487..867155cf1f93bf1936e9b19f14926726f362edaf 100644 --- a/src/linkahead/utils/server_side_scripting.py +++ b/src/linkahead/utils/server_side_scripting.py @@ -99,6 +99,19 @@ def _make_request(call, pos_args, opts, files=None): def run_server_side_script(call, *args, files=None, **kwargs): """ + Parameters + ---------- + call : str + name of the script to be called, potentially with path prefix (e.g. ``management/update.py``) + *args : list(str) + list of positional arguments + files : dict + dictionary with where keys are the argument names with prefix (e.g. ``-p1`` or ``-Ofile``) and + the values are the paths to the files to be uploaded. Note, that only the base name will be + used when uploaded. Files will be placed in the ``.upload_files`` folder. Thus, the script + will be called with the argument ``<key>=.upload_files/<basename>``. + **kwargs : dict + kwargs will be passed to ``_make_request`` Return ------