Merge branch 'pydata_sphinxs_theme' into 'main'

pdata sphinx theme

See merge request !100

doc/_templates/footer_end.html

+{{ project }} {{ release }}

doc/conf.py

 """rm -rf doc/_generated/; sphinx-build doc build/sphinx/html -E -a
 """
 
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+from ewoksppf import __version__ as release
+
 project = "ewoksppf"
-version = "0.1"
-copyright = "2021, ESRF"
+version = ".".join(release.split(".")[:2])
+copyright = "2021-2024, ESRF"
 author = "ESRF"
+docstitle = f"{project} {version}"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
     "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
     "sphinx.ext.viewcode",
-    "sphinxcontrib.mermaid",
     "sphinx_autodoc_typehints",
+    "sphinxcontrib.mermaid",
 ]
 templates_path = ["_templates"]
 exclude_patterns = []
 
 always_document_param_types = True
 
-html_theme = "classic"
-html_static_path = []
+# mermaid does not render when nbsphinx is used
+# https://github.com/spatialaudio/nbsphinx/issues/678
+nbsphinx_requirejs_path = ""
 
 autosummary_generate = True
 autodoc_default_flags = [
@@ -27,3 +37,26 @@ autodoc_default_flags = [
     "undoc-members",
     "show-inheritance",
 ]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "pydata_sphinx_theme"
+html_static_path = []
+html_theme_options = {
+    "icon_links": [
+        {
+            "name": "gitlab",
+            "url": "https://gitlab.esrf.fr/workflow/ewoks/ewoksppf",
+            "icon": "fa-brands fa-gitlab",
+        },
+        {
+            "name": "pypi",
+            "url": "https://pypi.org/project/ewoksppf",
+            "icon": "fa-brands fa-python",
+        },
+    ],
+    "footer_start": ["copyright"],
+    "footer_end": ["footer_end"],
+}

doc/index.rst

@@ -3,7 +3,7 @@ ewoksppf |version|
 
 *ewoksppf* provides task scheduling for cyclic `ewoks <https://ewoks.readthedocs.io/>`_ workflows.
 
-*ewoksppf* has been developed by the `Software group <http://www.esrf.eu/Instrumentation/software>`_ of the `European Synchrotron <https://www.esrf.eu/>`_.
+*ewoksppf* has been developed by the `Software group <http://www.esrf.fr/Instrumentation/software>`_ of the `European Synchrotron <https://www.esrf.fr/>`_.
 
 Getting started
 ---------------
@@ -29,11 +29,8 @@ Run the tests
     pip install ewoksppf[test]
     pytest --pyargs ewoksppf.tests
 
-Documentation
--------------
-
 .. toctree::
-    :maxdepth: 2
+    :hidden:
 
     parallel
     actors

setup.cfg

@@ -41,6 +41,7 @@ doc =
     sphinx >=4.5
     sphinxcontrib-mermaid >=0.7
     sphinx-autodoc-typehints >=1.16
+    pydata-sphinx-theme < 0.15
 
 # E501 (line too long) ignored for now
 # E203 and W503 incompatible with black formatting (https://black.readthedocs.io/en/stable/compatible_configs.html#flake8)