Upgrade documentation to the pydata_sphinx_theme

ci/requirements_rtd.txt

@@ -9,6 +9,6 @@ pygments[plugins]
 sphinxcontrib-programoutput
 silx
 nbsphinx
-sphinx-rtd-theme
 docutils<0.20
 ipython_genutils
+pydata-sphinx-theme

doc/source/changelog.rst

@@ -1,14 +1,15 @@
 :Author: Jérôme Kieffer
-:Date: 10/01/2024
+:Date: 11/01/2024
 :Keywords: changelog
 
 Change-log of versions
 ======================
 
-2024.1 UNRELEASED
------------------
+2024.01 UNRELEASED
+------------------
+- Change documentation template to `pydata`
 - Support XRDML formt (compatibility with MAUD software)
-- Support pathlib for reading PONI files 
+- Support pathlib for reading PONI files
 - Refactor `pyFAI-benchmark` tool (Thanks Edgar)
 - Possibility to define the detector orientation:
   + It is the position of the origin of the detector at any of the 4 corner of the image

doc/source/conf.py

@@ -75,13 +75,6 @@
 if sphinx.__version__ < "1.4":
     extensions.append('sphinx.ext.pngmath')
 
-# Set the theme to sphinx_rtd_theme when *not* building on Read The Docs.
-# The theme is set to default otherwise as Read The Docs uses its own theme anyway.
-if not on_rtd:
-    import sphinx_rtd_theme
-
-    extensions.append('sphinx_rtd_theme')
-
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 
@@ -145,13 +138,34 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default' if on_rtd else 'sphinx_rtd_theme'
+html_theme = "pydata_sphinx_theme"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 # html_theme_options = {}
-
+html_theme_options = {
+    "icon_links": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/silx-kit/pyFAI",
+            "icon": "fa-brands fa-github",
+        },
+        {
+            "name": "PyPI",
+            "url": "https://pypi.org/project/pyFAI",
+            "icon": "img/pypi.svg",
+            "type": "local",
+        },
+    ],
+    "show_toc_level": 1,
+    "navbar_align": "left",
+    "show_version_warning_banner": True,
+    "navbar_start": ["navbar-logo", "version"],
+    "navbar_center": ["navbar-nav"],
+    "footer_start": ["copyright"],
+    "footer_center": ["sphinx-version"],
+}
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
 
@@ -174,7 +188,7 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = []
+html_static_path = ["img"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

package/debian10/control

@@ -22,7 +22,7 @@ Build-Depends: cython3 (>=0.29.31),
                python3-sphinxcontrib.programoutput,
                python3-nbconvert,
                python3-nbsphinx,
-               python3-sphinx-rtd-theme,
+               python3-pydata-sphinx-theme,
                python3-pkg-resources,
                help2man,
                devscripts

package/debian11/control

@@ -21,7 +21,7 @@ Build-Depends: cython3 (>=0.29.31),
                python3-sphinxcontrib.programoutput,
                python3-nbconvert,
                python3-nbsphinx,
-               python3-sphinx-rtd-theme,
+               python3-pydata-sphinx-theme,
                python3-setuptools,
                help2man,
                devscripts

package/debian12/control

@@ -23,7 +23,7 @@ Build-Depends: cython3 (>=0.29.31),
                python3-sphinxcontrib.programoutput,
                python3-nbconvert,
                python3-nbsphinx,
-               python3-sphinx-rtd-theme,
+               python3-pydata-sphinx-theme,
                help2man,
                devscripts
 Standards-Version: 3.9.6

requirements.txt

@@ -13,3 +13,4 @@ PyOpenGL
 PyQt5
 hdf5plugin
 nbsphinx
+pydata-sphinx-theme