Skip to content

Read the Docs no longer injects html_baseurl: update test and comment #138

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

Merged
merged 1 commit into from
Aug 3, 2025
Merged

Read the Docs no longer injects html_baseurl: update test and comment #138

Show file tree
Hide file tree
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
3 changes: 1 addition & 2 deletions sphinxext/opengraph/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -250,8 +250,7 @@ def get_tags(


def ambient_site_url() -> str:
# readthedocs addons sets the READTHEDOCS_CANONICAL_URL variable,
# or defines the ``html_baseurl`` variable in conf.py
# readthedocs addons sets the READTHEDOCS_CANONICAL_URL variable
if rtd_canonical_url := os.getenv('READTHEDOCS_CANONICAL_URL'):
parse_result = urlsplit(rtd_canonical_url)
else:
Expand Down
2 changes: 1 addition & 1 deletion tests/test_options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,7 +305,7 @@ def test_rtd_override(app: Sphinx, monkeypatch):
@pytest.mark.sphinx('html', testroot='rtd-default')
def test_rtd_valid(app: Sphinx, monkeypatch):
monkeypatch.setenv('READTHEDOCS', 'True')
app.config.html_baseurl = 'https://failure.com/en/latest/'
monkeypatch.setenv('READTHEDOCS_CANONICAL_URL', 'https://failure.com/en/latest/')

app.build()
tags = conftest._og_meta_tags(app)
Expand Down
Loading