Skip to content

Move release related docs to new sub-folder #30304

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 our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Conversation

dstansby
Copy link
Member

PR summary

See #27396.

This moves release-related docs to their own folder within the docs (/release).

PR checklist

@github-actions github-actions bot added Documentation: build building the docs Documentation: devdocs files in doc/devel labels Jul 13, 2025
@jklymak
Copy link
Member

jklymak commented Jul 13, 2025

Probably this will need a 501 redirect on the server?

@dstansby
Copy link
Member Author

Probably this will need a 501 redirect on the server?

Does the spinx redirect directive not handle the redirects by itself?

I can't work out why the doc build is failing. It says

    ValueError: users/release_notes_next is already noted as redirecting to release/release_notes_next

but, as far as I can see there's only one redirect from users/release_notes_next 🤔

@story645
Copy link
Member

Does the spinx redirect directive not handle the redirects by itself?

I think there's one more level handled in https://github.com/matplotlib/matplotlib.org

@dstansby
Copy link
Member Author

Sorry, I'm not following - what does "one more level handled" mean?

@dstansby
Copy link
Member Author

Since the improvements/fixes to the redirection code are orthogonal to moving these docs around, I put them in #30309

@jklymak
Copy link
Member

jklymak commented Jul 14, 2025

Ok i had not noticed that you'd put a redirect-from in each file. Seems fine if it works! I was suggesting just redirecting the subdirectory at the server config, but if this caught everything it should be ok

@story645
Copy link
Member

Sorry, I'm not following - what does "one more level handled" mean?

Just that I remember having to ask @QuLogic to do some redirects on the matplotlib.org repo for the other PRs on that issue.

Copy link
Member

@QuLogic QuLogic left a comment

Choose a reason for hiding this comment

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

We probably should update mpl-sphinx-theme to point to the new URLs before the next release, to avoid extra redirects.

@@ -110,10 +110,10 @@
- all:
- changed-files:
- any-glob-to-any-file:
- 'doc/users/**'
- 'doc/release/**'
Copy link
Member

Choose a reason for hiding this comment

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

This is incorrect; we don't want the user guide label to apply to release docs.

@QuLogic
Copy link
Member

QuLogic commented Jul 14, 2025

Sorry, I'm not following - what does "one more level handled" mean?

Just that I remember having to ask @QuLogic to do some redirects on the matplotlib.org repo for the other PRs on that issue.

That was stable -> devel (which means independent build directories); this is all internal to the a single build, so shouldn't need anything server side.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation: build building the docs Documentation: devdocs files in doc/devel
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants