NotificationsYou must be signed in to change notification settings
Fork32.1k
Star67.3k

Docs: Fix build preview banner#104082

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.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Closed

hugovk wants to merge1 commit intopython:mainfromhugovk:docs-banner

Closed

Docs: Fix build preview banner#104082

hugovk wants to merge1 commit intopython:mainfromhugovk:docs-banner

Conversation

Copy link

Member

hugovk commentedMay 2, 2023

There should be a banner at the top of PR build previews for docs. Here's it working on this branch as a PR on my fork:

But for some reason it's missing for this upstream:

TODO

The code to control this:

cpython/Doc/conf.py

Lines 117 to 124 inf0ad456

	# Deployment preview information
	# (See .readthedocs.yml and https://docs.readthedocs.io/en/stable/reference/environment-variables.html)
	repository_url=os.getenv("READTHEDOCS_GIT_CLONE_URL")
	html_context= {
	"is_deployment_preview":os.getenv("READTHEDOCS_VERSION_TYPE")=="external",
	"repository_url":repository_url.removesuffix(".git")ifrepository_urlelseNone,
	"pr_id":os.getenv("READTHEDOCS_VERSION")
	}

Let's start with a draft PR to debug the env vars.

TEMP print all env vars

355ddc2

bedevere-bot added the awaiting core review label

May 2, 2023

hugovk added skip issue skip news labels

May 2, 2023

Copy link

MemberAuthor

hugovk commentedMay 2, 2023

It's working here too:

https://cpython-previews--104082.org.readthedocs.build/en/104082/

Looking at another PR build that is missing the banner:

The RtD build page says:

Configure your documentation builds! Adding a.readthedocs.yaml file to your project is the recommended way to configure your documentation builds. You can declare dependencies, set up submodules, and many other great features.

And looking at the PR, it's from before the#103843 was merged that updatedconf.py, so I think we're good here.

One thing to do though, is backport#103843 to at least 3.11 so we get banners on backport builds too.