Merge branch 'improve_docs' into 'main'

Improve docs

See merge request !69

.gitlab-ci.yml

 include:
-  - remote: https://gitlab.esrf.fr/workflow/ewoks/ewoks/raw/main/.gitlab-ci-template.yml
+  - remote: https://gitlab.esrf.fr/workflow/ewoks/ewoksci/raw/main/.gitlab-ci-template.yml
 
 test-3.6:
   extends: .test-3.6

CONTRIBUTING.md

-<a href="https://gitlab.esrf.fr/workflow/ewoks/ewoks/-/blob/main/CONTRIBUTING.md" target="_blank">CONTRIBUTING.md</a>
\ No newline at end of file
+<a href="https://gitlab.esrf.fr/workflow/ewoks/ewoksci/-/blob/main/CONTRIBUTING.md" target="_blank">CONTRIBUTING.md</a>
\ No newline at end of file

doc/_templates/autosummary/class.rst

@@ -6,27 +6,3 @@
    :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

doc/conf.py

@@ -6,14 +6,19 @@ release = "0.1"
 copyright = "2021, ESRF"
 author = "ESRF"
 
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.autosummary", "sphinxcontrib.mermaid"]
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.viewcode",
+    "sphinxcontrib.mermaid",
+    "sphinx_autodoc_typehints",
+]
 templates_path = ["_templates"]
 exclude_patterns = []
 
-autodoc_typehints = "description"
-autodoc_typehints_description_target = "all"
+always_document_param_types = True
 
-html_theme = "alabaster"
+html_theme = "classic"
 html_static_path = []
 
 autosummary_generate = True

setup.cfg

@@ -23,8 +23,7 @@ package_dir=
 packages=find:
 python_requires = >=3.6
 install_requires = 
-    ewoksutils
-    ewokscore
+    ewokscore >=0.1.1
     pypushflow
 
 [options.packages.find]
@@ -32,16 +31,16 @@ where=src
 
 [options.extras_require]
 test =
-    pytest
-    ewokscore[test]
+    pytest >=7
 dev =
     %(test)s
-    black
-    flake8
+    black >=22
+    flake8 >=4
 doc =
     %(test)s
-    sphinx
-    sphinxcontrib-mermaid
+    sphinx >=4.5
+    sphinxcontrib-mermaid >=0.7
+    sphinx-autodoc-typehints >=1.16
 
 # E501 (line too long) ignored for now
 # E203 and W503 incompatible with black formatting (https://black.readthedocs.io/en/stable/compatible_configs.html#flake8)