Skip to content

add markdown suffix for sphinx source backlinks #1200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
jan-glx wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

add markdown suffix for sphinx source backlinks #1200

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
05e3cb3
add markdown suffix for sphinx source backlinks
jan-glx Sep 1, 2026
a5decf4
populate html_theme_options for edit this page links
jan-glx Sep 1, 2026
d0d35a2
!fixup a5decf48898c4761ed9ebd835e0a0275b0ac02e2
jan-glx Sep 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"]
Expand All @@ -43,6 +43,7 @@
"conf_py_path": "/docs/", # Path in the checkout to the docs root
}


# -- General configuration ---------------------------------------------------

# Add any Sphinx extension module names here, as strings.
Expand Down Expand Up @@ -100,6 +101,7 @@

source_suffix = {
".rst": "restructuredtext",
".md": "myst-nb",
".ipynb": "myst-nb",
".myst": "myst-nb",
}
Expand Down Expand Up @@ -161,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"
Expand Down