Commit 7ec1ed7e authored by Wout De Nolf's avatar Wout De Nolf
Browse files

add documentation

parent 0093829e
Pipeline #52146 passed with stages
in 55 seconds
......@@ -15,6 +15,7 @@ __pycache__/
/dist/
*.egg-info/
.eggs/
/doc/_generated
# Unittest / coverage
*.py,cover
......
......@@ -3,3 +3,9 @@ include:
test-3.6:
extends: ".test-3.6"
deploy_docs:
extends: ".sphinx_and_artifacts"
pages:
extends: ".pages"
# EwoksDask: Dask binding for Ewoks
ewoskdask provides distributed task scheduling for Ewoks workflows.
## Install
```bash
python -m pip install ewoksdask[test]
```
## Test
```bash
pytest --pyargs ewoksdask.tests
```
## Documentation
https://workflow.gitlab-pages.esrf.fr/ewoks/ewoksdask/
{{ fullname | escape | underline}}
.. currentmodule:: {{ module }}
.. autoclass:: {{ objname }}
:members:
:show-inheritance:
:inherited-members:
{% block methods %}
.. automethod:: __init__
{% if methods %}
.. rubric:: {{ _('Methods') }}
.. autosummary::
{% for item in methods %}
~{{ name }}.{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
{% block attributes %}
{% if attributes %}
.. rubric:: {{ _('Attributes') }}
.. autosummary::
{% for item in attributes %}
~{{ name }}.{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
\ No newline at end of file
{{ fullname | escape | underline}}
.. automodule:: {{ fullname }}
{% block attributes %}
{% if attributes %}
.. rubric:: Module Attributes
.. autosummary::
:toctree:
{% for item in attributes %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
{% block functions %}
{% if functions %}
.. rubric:: {{ _('Functions') }}
.. autosummary::
:toctree:
{% for item in functions %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
{% block classes %}
{% if classes %}
.. rubric:: {{ _('Classes') }}
.. autosummary::
:toctree:
{% for item in classes %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
{% block exceptions %}
{% if exceptions %}
.. rubric:: {{ _('Exceptions') }}
.. autosummary::
:toctree:
{% for item in exceptions %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
{% block modules %}
{% if modules %}
.. rubric:: Modules
.. autosummary::
:toctree:
:recursive:
{% for item in modules %}
{{ item }}
{%- endfor %}
{% endif %}
{% endblock %}
\ No newline at end of file
API documentation
=================
.. autosummary::
:toctree: _generated
:recursive:
ewoksdask
"""rm -rf doc/_generated/; python setup.py build_sphinx -E -a
"""
copyright = "2021, ESRF"
author = "ESRF"
extensions = ["sphinx.ext.autodoc", "sphinx.ext.autosummary"]
templates_path = ["_templates"]
exclude_patterns = []
html_theme = "alabaster"
html_static_path = []
autosummary_generate = True
autodoc_default_flags = [
"members",
"undoc-members",
"show-inheritance",
]
ewoskdask |release|
===================
ewoskdask provides distributed task scheduling for Ewoks workflows.
ewoskdask has been developed by the `Software group <http://www.esrf.eu/Instrumentation/software>`_ of the `European Synchrotron <https://www.esrf.eu/>`_.
.. toctree::
:maxdepth: 2
api
......@@ -9,7 +9,9 @@ long_description_content_type = text/markdown
license = MIT
url = https://gitlab.esrf.fr/workflow/ewoks/ewoksdask
project_urls =
Bug Tracker = https://gitlab.esrf.fr/workflow/ewoks/ewoksdask/-/issues
Source = https://gitlab.esrf.fr/workflow/ewoks/ewoksdask
Documentation = https://workflow.gitlab-pages.esrf.fr/ewoks/ewoksdask
Tracker = https://gitlab.esrf.fr/workflow/ewoks/ewoksdask/issues
classifiers =
Intended Audience :: Science/Research
License :: OSI Approved :: MIT License
......@@ -33,6 +35,8 @@ dev =
black
flake8
%(test)s
doc =
sphinx
# E501 (line too long) ignored for now
# E203 and W503 incompatible with black formatting (https://black.readthedocs.io/en/stable/compatible_configs.html#flake8)
......@@ -41,3 +45,9 @@ ignore = E501, E203, W503
max-line-length = 88
exclude =
.eggs
[build_sphinx]
project = ewoksdask
version = attr: ewoksdask.__version__
release = 0.1
source-dir = ./doc
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