From bd23ee309097e415276155633a21888d9686125f Mon Sep 17 00:00:00 2001
From: ptresson <paul.tresson@ird.fr>
Date: Wed, 20 Nov 2024 16:24:58 +0100
Subject: [PATCH] update rtd config to have github link and logo on the top
---
docs/source/conf.py | 24 +++++++++++++++++++++---
1 file changed, 21 insertions(+), 3 deletions(-)
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 8c8f77d..497cca4 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -40,9 +40,6 @@ release = version
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-
-
-
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
@@ -65,3 +62,24 @@ source_suffix = {
html_theme = "pydata_sphinx_theme"
html_static_path = ["_static"]
html_favicon = "./../../icons/favicon.svg"
+html_logo = "./../../icons/favicon.svg"
+
+html_theme_options = {
+ "header_links_before_dropdown": 6,
+ "sidebarwidth": 200,
+ "icon_links": [
+ {
+ "name": "GitHub",
+ "url": "https://github.com/umr-amap/iamap",
+ "icon": "fa-brands fa-github",
+ },
+ ],
+ "show_version_warning_banner": True,
+ "footer_start": ["copyright"],
+ "footer_center": ["sphinx-version"],
+ "secondary_sidebar_items": {
+ "**/*": ["page-toc", "edit-this-page", "sourcelink"],
+ "examples/no-sidebar": [],
+ },
+ }
+
--
GitLab