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

Change root url to docs.python.org #220

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

Change root url to docs.python.org #220

wants to merge 1 commit into from

Conversation

StanFromIreland
Copy link

@StanFromIreland StanFromIreland commented Feb 2, 2025 •
edited by github-actions bot
Loading

AA-Turner
AA-Turner reviewed Feb 2, 2025
View reviewed changes
python_docs_theme/theme.conf
@@ -30,7 +30,7 @@ hosted_on =
issues_url =
license_url =
root_name = Python
root_url = https://www.python.org/
root_url = https://www.docs.python.org/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This changes the default for every user of this theme. Should we use html_theme_options?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could, also the link has to be docs.python.org as for some reason it is otherwise broken.

@hugovk
Copy link
Member

hugovk commented Feb 2, 2025

Mobile

image

The logo always links to docs.python.org. That's okay when we're looking the 3.13 docs, but if we're looking at, say, 3.11 or 3.14, we'll end up at a different docs set which would be confusing.

Can it point to the same docs homepage we're looking at?

Desktop

With this change, these circled links both point to the docs homepage:

image

Before, the first one pointed to www.python.org, and the chevrons "»" indicated a hierarchy. Is it a bit odd that the upper level link is the same as the next one?

Or I guess, the top one is docs.python.org and the next is docs.python.org/3.x, so that's kind of a hierarchy, for the default case of docs.python.org >> docs.python.org/3, but maybe not really for, say, docs.python.org >> docs.python.org/3.11?

And do we want to lose the link to www.python.org?

The logo doesn't point to anything here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AA-Turner AA-Turner AA-Turner left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Docs Python.org button
3 participants
@StanFromIreland @hugovk @AA-Turner