From 05e3cb32930a463611b318052ca69715af991cf5 Mon Sep 17 00:00:00 2001 From: Jan Gleixner Date: Tue, 1 Sep 2026 20:20:45 +0200 Subject: [PATCH 1/3] add markdown suffix for sphinx source backlinks --- docs/conf.py | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/conf.py b/docs/conf.py index 593dc88cd..309dc06f1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -100,6 +100,7 @@ source_suffix = { ".rst": "restructuredtext", + ".md": "myst-nb", ".ipynb": "myst-nb", ".myst": "myst-nb", } From a5decf48898c4761ed9ebd835e0a0275b0ac02e2 Mon Sep 17 00:00:00 2001 From: Jan Gleixner Date: Tue, 1 Sep 2026 20:41:54 +0200 Subject: [PATCH 2/3] populate html_theme_options for edit this page links --- docs/conf.py | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/docs/conf.py b/docs/conf.py index 309dc06f1..bf6853878 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -24,7 +24,7 @@ author = info["Author"] copyright = f"{datetime.now():%Y}, {author}" version = info["Version"] -# repository_url = f"https://github.com/scverse/{project_name}" +repository_url = f"https://github.com/scverse/{project_name}" # The full version, including alpha/beta/rc tags release = info["Version"] @@ -43,6 +43,16 @@ "conf_py_path": "/docs/", # Path in the checkout to the docs root } +html_theme_options = { + "navigation_with_keys": True, + "show_toc_level": 4, + "repository_url": repository_url, + "repository_branch": "main", + "path_to_docs": "docs", + "use_repository_button": True, + "use_edit_page_button": True, +} + # -- General configuration --------------------------------------------------- # Add any Sphinx extension module names here, as strings. From d0d35a2adb9966187c28113ca8c7f7a55775100c Mon Sep 17 00:00:00 2001 From: Jan Gleixner Date: Tue, 1 Sep 2026 20:50:15 +0200 Subject: [PATCH 3/3] !fixup a5decf48898c4761ed9ebd835e0a0275b0ac02e2 Removed old html_theme_options and updated with new settings. --- docs/conf.py | 16 +++++----------- 1 file changed, 5 insertions(+), 11 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index bf6853878..f7d2536fd 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -43,15 +43,6 @@ "conf_py_path": "/docs/", # Path in the checkout to the docs root } -html_theme_options = { - "navigation_with_keys": True, - "show_toc_level": 4, - "repository_url": repository_url, - "repository_branch": "main", - "path_to_docs": "docs", - "use_repository_button": True, - "use_edit_page_button": True, -} # -- General configuration --------------------------------------------------- @@ -172,8 +163,11 @@ html_theme_options = { "navigation_with_keys": True, "show_toc_level": 4, - # "repository_url": repository_url, - # "use_repository_button": True, + "repository_url": repository_url, + "repository_branch": "main", + "path_to_docs": "docs", + "use_repository_button": True, + "use_edit_page_button": True, } pygments_style = "default"