File size: 1,856 Bytes
31dc8dc | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 | # General information about the project.
project = "Diffulex"
author = "Diffulex Contributors"
copyright = f"2025-2026, {author}"
# Version information.
import re
with open("../pyproject.toml", "r", encoding="utf-8") as f:
content = f.read()
match = re.search(r'version\s*=\s*["\']([^"\']+)["\']', content)
if match:
version = match.group(1)
else:
version = "0.0.1" # fallback
release = version
extensions = [
"sphinx_tabs.tabs",
"sphinxcontrib.httpdomain",
"sphinx.ext.napoleon",
"sphinx.ext.intersphinx",
"sphinx_reredirects",
"sphinx.ext.mathjax",
"myst_parser",
]
autodoc_typehints = "description"
source_suffix = {
".rst": "restructuredtext",
".md": "markdown",
}
myst_enable_extensions = [
"colon_fence",
"deflist",
]
redirects = {"get_started/try_out": "../index.html#getting-started"}
language = "en"
exclude_patterns = [
"_build",
"Thumbs.db",
".DS_Store",
"README.md",
"**/*libinfo*",
"**/*version*",
]
pygments_style = "sphinx"
todo_include_todos = False
# -- Options for HTML output ----------------------------------------------
html_theme = "furo"
templates_path = []
html_static_path = ["_static"]
html_css_files = ["custom.css"]
footer_copyright = "© 2025-2026 Diffulex"
footer_note = " "
html_theme_options = {
"light_logo": "img/logo-v2.png",
"dark_logo": "img/logo-v2.png",
}
header_links = [
("Home", "https://github.com/SJTU-DENG-Lab/Diffulex"),
("Github", "https://github.com/SJTU-DENG-Lab/Diffulex"),
]
html_context = {
"footer_copyright": footer_copyright,
"footer_note": footer_note,
"header_links": header_links,
"display_github": True,
"github_user": "SJTU-DENG-Lab",
"github_repo": "Diffulex",
"github_version": "main/docs/",
"theme_vcs_pageview_mode": "edit",
}
|