Commit ba635748 authored by Wout De Nolf's avatar Wout De Nolf
Browse files

improve docs

parent 9dd7c24e
Pipeline #78281 passed with stages
in 3 minutes and 46 seconds
# EwoksOrange: Orange binding for Ewoks
# ewoksorange
*ewoksorange* provides s desktop graphical interface for [ewoks](https://ewoks.readthedocs.io/).
## Install
......
......@@ -14,7 +14,10 @@ extensions = [
templates_path = ["_templates"]
source_suffix = [".rst", ".md"]
exclude_patterns = ["build", "**.ipynb_checkpoints"]
pygments_style = "sphinx"
autodoc_typehints = "description"
autodoc_typehints_description_target = "all"
autosummary_generate = True
autodoc_default_flags = [
......
......@@ -6,9 +6,34 @@
|ewoksimg| ewoksorange
========================
ewoksorange is the Orange bindings for Ewoks.
*ewoksorange* provides desktop graphical interface for `ewoks <https://ewoks.readthedocs.io/>`_.
ewoksorange has been developed by the `Software group <http://www.esrf.eu/Instrumentation/software>`_ of the `European Synchrotron <https://www.esrf.eu/>`_.
*ewoksorange* has been developed by the `Software group <http://www.esrf.eu/Instrumentation/software>`_ of the `European Synchrotron <https://www.esrf.eu/>`_.
Getting started
---------------
Install requirements
.. code:: bash
python -m pip install ewoksorange[orange]
Launch to graphical interface
.. code:: bash
ewoks-canvas
Run the tests
.. code:: bash
python -m pip install ewoksorange[test]
pytest --pyargs ewoksorange.tests
Documentation
-------------
.. toctree::
:maxdepth: 2
......
......@@ -189,7 +189,7 @@ def ows_to_ewoks(
link = {
"source": id_to_title.get(ows_link.source_node_id, ows_link.source_node_id),
"target": id_to_title.get(ows_link.sink_node_id, ows_link.sink_node_id),
"data_mapping": [{"target_input": sink_name, "source_output": source_name}],
"data_mapping": [{"source_output": source_name, "target_input": sink_name}],
}
links.append(link)
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment