Skip to content

gh-150693: Combine docs sections for external resources - #150694

Merged
hugovk merged 2 commits into
python:mainfrom
miameows:combine-resource-sections-docs
Aug 6, 2026
Merged

gh-150693: Combine docs sections for external resources#150694
hugovk merged 2 commits into
python:mainfrom
miameows:combine-resource-sections-docs

Conversation

@miameows

@miameows miameows commented May 31, 2026

Copy link
Copy Markdown
Contributor

This PR removes "Other resources" from the docs sidebar and puts all active links in the front-page section made by #150030. Note that 2 of the links from the sidebar go to the deprecated Python wiki, so I've dropped those entirely.

@python-cla-bot

python-cla-bot Bot commented May 31, 2026

Copy link
Copy Markdown

All commit authors signed the Contributor License Agreement.

CLA signed

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #32926611 | 📁 Comparing ebe6385 against main (f4bda4d)

  🔍 Preview build  

1 file changed
± index.html

@hugovk

hugovk commented Jun 4, 2026

Copy link
Copy Markdown
Member

Thanks for this!

Let's re-arrange them a bit.

In this PR:

image

Perhaps:

  • devguide, PEPs
  • packaging guide, typing guide
  • a/v talks

@hugovk

hugovk commented Aug 4, 2026

Copy link
Copy Markdown
Member

@miameows Hi! Would you like to update this to re-arrange like in #150694 (comment)?

@miameows

miameows commented Aug 6, 2026

Copy link
Copy Markdown
Contributor Author

@miameows Hi! Would you like to update this to re-arrange like in #150694 (comment)?

Sorry for the delay, my life has been a little crazy lately. I will try to get this done this weekend!

@miameows

miameows commented Aug 6, 2026

Copy link
Copy Markdown
Contributor Author

@hugovk All done! Please let me know if anything else needs to be fixed.

@hugovk hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Great, thanks!

image

@hugovk
hugovk merged commit 9cbb9e5 into python:main Aug 6, 2026
29 checks passed
@hugovk hugovk added awaiting merge needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes needs backport to 3.15 pre-release feature fixes, bugs and security fixes labels Aug 6, 2026
@miss-islington-app

Copy link
Copy Markdown

Thanks @miameows for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14.
🐍🍒⛏🤖

@miss-islington-app

Copy link
Copy Markdown

Thanks @miameows for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.15.
🐍🍒⛏🤖

@miss-islington-app

Copy link
Copy Markdown

Thanks @miameows for the PR, and @hugovk for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13.
🐍🍒⛏🤖

@bedevere-app

bedevere-app Bot commented Aug 6, 2026

Copy link
Copy Markdown

GH-155275 is a backport of this pull request to the 3.14 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.14 bugs and security fixes label Aug 6, 2026
@bedevere-app

bedevere-app Bot commented Aug 6, 2026

Copy link
Copy Markdown

GH-155276 is a backport of this pull request to the 3.15 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.15 pre-release feature fixes, bugs and security fixes label Aug 6, 2026
@bedevere-app

bedevere-app Bot commented Aug 6, 2026

Copy link
Copy Markdown

GH-155277 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app Bot removed the needs backport to 3.13 bugs and security fixes label Aug 6, 2026
hugovk pushed a commit that referenced this pull request Aug 6, 2026
hugovk pushed a commit that referenced this pull request Aug 6, 2026
hugovk pushed a commit that referenced this pull request Aug 6, 2026
@hugovk

hugovk commented Aug 6, 2026

Copy link
Copy Markdown
Member

This has now deployed:

We can see the middle section has updated but the sidebar hasn't:

image

That's because it turns out the docs server build actually swaps in another sidebar so it can include all the "Docs by version" links:

https://github.com/python/docsbuild-scripts/blob/main/templates/indexsidebar.html

And look, it has this comment :)

{# XXX: many of these should probably be merged in the main docs #}

We don't usually backport non-security changes to security branches (3.10-3.12).

So let's wrap that final h3 and ul in something like:

{% if version in ("3.10", "3.11", "3.12") %}
...
{% endif %}

And remove or update the comment.

@miameows Would you like to open a PR for this in https://github.com/python/docsbuild-scripts?

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants