Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-16 21:06:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Apply md changes after sphinx version update

Browse source
This commit is contained in:
Griatch 2025-08-15 18:37:58 +02:00
parent 3ef3cf3217
commit 524465eaa5
435 changed files with 571 additions and 693 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/source/conf.py
View file

@ -33,7 +33,7 @@ html_css_files = [
# -- General configuration ---------------------------------------------------
extensions = [
#"sphinx_multiversion",
# "sphinx_multiversion",
"sphinx.ext.napoleon",
"sphinx.ext.autosectionlabel",
"sphinx.ext.viewcode",
@ -56,49 +56,38 @@ templates_path = ["_templates"]
html_static_path = ["_static"]
# -- Sphinx-multiversion config ----------------------------------------------
# which branches to include in multi-versioned docs
# smv_branch_whitelist = r"^develop$|^v[0-9\.]+?$"
# smv_branch_whitelist = r"^develop$|^master$|^v1.0$"
#smv_branch_whitelist = r"^main$"
#smv_outputdir_format = "{config.release}"
# don't make docs for tags
#smv_tag_whitelist = r"^$"
# -- Multiversion sidebar ----------------------------------------------
# used to fill in versioning.html links for versions that are not actually built.
# These are also read from the deploy.py script. These are also the names of
# the folders built in the gh-pages evennia branch, under docs/.
# See docs/deploy.py for more details on how to add to this during a major release.
latest_version = "latest"
legacy_versions = ["5.x", "4.x", "3.x", "2.x", "1.x", "0.x"]
legacy_branches = ["v5.0.0", "v4.0.0", "v3.0.0", "v2.0.0", "v1.0.0", "v0.9.5"]
DOCS_BASE = "https://www.evennia.com/docs/"
def add_legacy_versions_to_html_page_context(app, pagename, templatename, context, doctree):
# Add "latest" (main) version
context["versions"] = [
{
"release": "latest",
"name": "main",
"url": f"{DOCS_BASE}latest/index.html"
}
{"release": "latest", "name": "main", "url": f"{DOCS_BASE}latest/index.html"}
]
# Add legacy versions
LVersion = namedtuple("legacy_version", ["release", "name", "url", "branch"])
context["legacy_versions"] = [
LVersion(
release=branch, # e.g. v5.0.0
name=vers, # e.g. 5.x
release=branch, # e.g. v5.0.0
name=vers, # e.g. 5.x
url=f"{DOCS_BASE}{vers}/index.html", # absolute path!
branch=branch
branch=branch,
)
for vers, branch in zip(legacy_versions, legacy_branches)
]
context["current_is_legacy"] = False
# -- Options for HTML output -------------------------------------------------
html_theme = "nature"