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

fix(docs): use environment variable instead of config context for html_baseurl #1049

Merged
merged 1 commit into from
Jun 14, 2023
Merged

fix(docs): use environment variable instead of config context for html_baseurl #1049

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
28 changes: 13 additions & 15 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
import subprocess # noqa: TID251
import sys
from typing import Any, Dict, Optional
from urllib.parse import urljoin

from sphinx.application import Sphinx

Expand Down Expand Up @@ -259,11 +258,23 @@ def linkcode_resolve(domain: str, info: Dict[str, Any]) -> Optional[str]:
if not _IS_READTHEDOCS:
notfound_urls_prefix = "/"

# ignore common link types that we don't particularly care about or are unable to check
linkcheck_ignore = [
r"https?://github.com/.+?/.+?/(issues|pull)/\d+",
r"https?://support.discord.com/",
]

if _IS_READTHEDOCS:
# set html_baseurl based on readthedocs-provided env variable
# https://github.com/readthedocs/readthedocs.org/pull/10224
# https://docs.readthedocs.io/en/stable/reference/environment-variables.html#envvar-READTHEDOCS_CANONICAL_URL
html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL")
if not html_baseurl:
raise RuntimeError("Expected `READTHEDOCS_CANONICAL_URL` to be set on readthedocs")

# enable opensearch (see description somewhere below)
html_use_opensearch = html_baseurl.rstrip("/")


# -- Options for HTML output ----------------------------------------------

Expand Down Expand Up @@ -360,7 +371,7 @@ def linkcode_resolve(domain: str, info: Dict[str, Any]) -> Optional[str]:
# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ''
# html_use_opensearch = '' # NOTE: this is being set above

# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
Expand Down Expand Up @@ -476,19 +487,6 @@ def setup(app: Sphinx) -> None:
app.config.html_context["discord_invite"] = "https://discord.gg/disnake"
app.config.resource_links["disnake"] = "https://discord.gg/disnake"

# readthedocs appends additional stuff to conf.py,
# we can't access it above since it wouldn't have run yet
if _IS_READTHEDOCS:
# this is the "canonical" url, which always points to stable in our case
if not (base_url := globals().get("html_baseurl")):
raise RuntimeError("Expected `html_baseurl` to be set on readthedocs")

# special case for convenience: if latest, use that for opensearch
if os.environ["READTHEDOCS_VERSION"] == "latest":
base_url = urljoin(base_url, "../latest")

app.config["html_use_opensearch"] = base_url.rstrip("/")

# HACK: avoid deprecation warnings caused by sphinx always iterating over all class attributes
import disnake

Expand Down