Skip to content

Handle Sphinx context injection deprecation #66

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Handle Sphinx context injection deprecation #66

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
14 changes: 13 additions & 1 deletion docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import sys
from datetime import date
from os import path
from os import path, environ

project = "AiiDA"
author = "The AiiDA team."
Expand Down Expand Up @@ -87,6 +87,18 @@
"doc_path": "docs/",
}

# handling deprecation of Sphinx context injection at build time
# see https://github.com/pydata/xarray/issues/9251

# Set canonical URL from the Read the Docs Domain
html_baseurl = environ.get("READTHEDOCS_CANONICAL_URL", "")

# Tell Jinja2 templates the build is running on Read the Docs
if environ.get("READTHEDOCS", "") == "True":
html_context["READTHEDOCS"] = True

# end deprecation handling

html_sidebars = {
"index": [],
"sections/**": ["sbar-aiida", "sidebar-nav-bs"],
Expand Down