Add sphinx_immaterial theme

docs/requirements.in

@@ -1,4 +1,7 @@
 -c ../requirements.txt
 
-sphinx-rtd-theme
-sphinx-autobuild
+sphinx-autobuild
+sphinx_immaterial
+sphinx>=4.0.0
+sphinx-autobuild
+sphinx-intl

docs/source/conf.py

@@ -21,19 +21,108 @@
 
 extensions = [
     "sphinx.ext.todo",
-    "sphinx_rtd_theme",
+    "sphinx_immaterial"
 ]
 
-templates_path = ["_templates"]
-exclude_patterns = []
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
 
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The master toctree document.
+master_doc = 'index'
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "sphinx_rtd_theme"
+exclude_patterns = ['_build']
+pygments_style = 'sphinx'
+
+html_theme = "sphinx_immaterial"
+html_favicon = "_static/favicon.ico"
 html_static_path = ["_static"]
-html_logo = "_static/logo.webp"
+html_logo = "_static/logo.png"
+
+# Material theme options (see theme.conf for more information)
 html_theme_options = {
-    "logo_only": True,
+    "icon": {
+        "repo": "fontawesome/brands/github",
+        "edit": "material/file-edit-outline",
+    },
+    "site_url": "https://demo-terravisu-territoires.makina-corpus.com/",
+    "repo_url": "https://github.com/Terralego/TerraVisu/",
+    "repo_name": "TerraVisu",
+    "edit_uri": "blob/main/docs",
+    "globaltoc_collapse": True,
+    "features": [
+        "navigation.expand",
+        # "navigation.tabs",
+        # "toc.integrate",
+        "navigation.sections",
+        # "navigation.instant",
+        # "header.autohide",
+        "navigation.top",
+        # "navigation.tracking",
+        # "search.highlight",
+        "search.share",
+        "toc.follow",
+        "toc.sticky",
+        "content.tabs.link",
+        "announce.dismiss",
+    ],
+    "palette": [
+        {
+            "media": "(prefers-color-scheme: light)",
+            "scheme": "default",
+            "primary": "blue",
+            "accent": "light-blue",
+            "toggle": {
+                "icon": "material/weather-night",
+                "name": "Switch to dark mode",
+            },
+        },
+        {
+            "media": "(prefers-color-scheme: dark)",
+            "scheme": "slate",
+            "primary": "red",
+            "accent": "deep-orange",
+            "toggle": {
+                "icon": "material/weather-sunny",
+                "name": "Switch to light mode",
+            },
+        },
+    ],
+    "social": [
+        {
+            "icon": "fontawesome/brands/github",
+            "link": "https://github.com/Terralego/TerraVisu/"
+        },
+        {
+            "icon": "fontawesome/brands/linkedin",
+            "link": "https://www.linkedin.com/company/makina-corpus",
+        },
+    ],
+    "toc_title_is_page_title": True,
+}
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'TerraVisudoc'
+
+latex_documents = [
+    ('index', 'TerraVisu.tex', 'TerraVisu Documentation',
+     'Makina Corpus Territoires', 'manual'),
+]
+
+man_pages = [
+    ('index', 'terravisu', 'TerraVisu Documentation',
+     ['Makina Corpus Territoires'], 1)
+]
+html_sidebars = {
+    "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
 }
+texinfo_documents = [
+    ('index', 'TerraVisu', 'TerraVisu Documentation',
+     'Makina Corpus Territoires', 'TerraVisu', 'One line description of project.',
+     'Miscellaneous'),
+]

docs/source/others/changelog.rst

@@ -9,6 +9,10 @@ Changelog
 
 - Update to python 3.12
 
+**Documentation:**
+
+- Add sphinx_immaterial theme
+
 
 2024.06.0      (2024-06-21)
 ---------------------------