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.

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

[Doc]: Release docs include Next what's new pages #27864

Open
dstansby opened this issue Mar 5, 2024 · 9 comments
Open

[Doc]: Release docs include Next what's new pages #27864

dstansby opened this issue Mar 5, 2024 · 9 comments

Comments

@dstansby
Copy link
Member

dstansby commented Mar 5, 2024

Documentation Link

https://matplotlib.org/stable/users/next_whats_new.html

Problem

Ideally this page shouldn't be in the docs for releases.

Suggested improvement

No response

@ksunden
Copy link
Member

ksunden commented Mar 5, 2024

I don't think it is a real problem, the page is not linked to from https://matplotlib.org/stable/users/release_notes.html

So while yes it exists, it only is accessible by actively going to the url. (Or I guess by version switching from devdocs, at which point I don't really see a practical difference between loading an empty page and a 404)

The exclusion of the link from the parent page is managed automatically by checking for the release mode tag at build time.

I'm of the opinion that adding a manual step back to the release docs generation is clearly the wrong path forward, and that the complexity of an automated solution here is likely worse than the problem.

@rcomer
Copy link
Member

rcomer commented Mar 5, 2024

It's in the sidebar of https://matplotlib.org/stable/users/release_notes.html. Is there a way to exclude it from there? It wasn't there for v3.7.

@timhoffm
Copy link
Member

timhoffm commented Mar 5, 2024

The sidebar is empty since #27800. So that’s not an issue anymore.

@dstansby
Copy link
Member Author

dstansby commented Mar 5, 2024

The sidebar on e.g., https://matplotlib.org/devdocs/users/prev_whats_new/whats_new_3.8.0.html isn't empty though, and that shows up with "Next what's new?" and "Next API changes" at the top of the sidebar:
Screenshot 2024-03-05 at 19 50 20

@timhoffm
Copy link
Member

timhoffm commented Mar 5, 2024

Yes, but #27800 deactivates that sidebar and is milestoned for 3.9.

@dstansby
Copy link
Member Author

dstansby commented Mar 5, 2024

As far as I can tell, it only deactivates it for one page, https://matplotlib.org/devdocs/users/release_notes.html, and not other pages, e.g., https://matplotlib.org/devdocs/users/prev_whats_new/whats_new_3.8.0.html. The sidebar is turning up on the previous link, which is a devdocs link.

@timhoffm
Copy link
Member

timhoffm commented Mar 5, 2024

Oh, I see. Then, #27800 should be extended to show blank sidebars as well for api/prev_api_changes/* and users/prev_whats_new/*, which are logical subpages of the release notes.

On a side note, the relation between the logical toc hierarchy and the file structure is not quite trivial 😢.

@dstansby
Copy link
Member Author

dstansby commented Mar 6, 2024

I think being on the "What's new for 3.8" and being able to see the section navigation is useful though, for example to go to the API changes or GitHub statistics. Surely the right solution to this is find a way to exclude "Next what's new" and "Next API changes" from release builds?

@timhoffm
Copy link
Member

timhoffm commented Mar 6, 2024

I think being on the "What's new for 3.8" and being able to see the section navigation is useful though, for example to go to the API changes or GitHub statistics.

I agree in theory, but due to the somewhat convoluted structure the menu is rather unusable. Note that there is a mix of 3.8.0 and 3.8.1 topics and "Github statistics for 3.8.1" even appears twice:

grafik

So until someone tries to untangle our incongruent use of logical hierarchy (sections) and page hierarchy, this side bar is rubbish.

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

No branches or pull requests

4 participants