Skip to content
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

Jump to bottom

ci: define canonical url and context for rtd #121

Merged
merged 1 commit into from
Jul 26, 2024
Merged

ci: define canonical url and context for rtd #121

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
7 changes: 7 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,13 @@ def canonical_url() -> str:
html_static_path = ["_static"]
html_theme = "sphinx_rtd_theme"
html_title = f"{project} v{release}"
# define canonical URL for Read the Docs custom domain
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
if os.environ.get("READTHEDOCS", "") == "True":
if "html_context" not in globals():
html_context = {}
# tell Jinja2 the build is running on Read the Docs
html_context["READTHEDOCS"] = True


linkcheck_allowed_redirects = {
Expand Down
Loading