-
-
Notifications
You must be signed in to change notification settings - Fork 25.8k
DOC restructure changelog (in particular for switching to pydata-sphinx-theme) #28255
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Targeting main
is fine for this I'd say.
Oh by the way, if this PR is merged can maintainers kindly sync |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just spotted a typo
Thanks @Charlie-XIAO |
@Charlie-XIAO the |
Thanks @adrinjalali! |
…nx-theme) (scikit-learn#28255) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
…nx-theme) (scikit-learn#28255) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
…nx-theme) (#28255) Co-authored-by: Guillaume Lemaitre <g.lemaitre58@gmail.com>
Not sure if this can be directly put into main or I should target the
new_web_theme
branch.This PR refactors the changelogs a bit. In particular, it avoids multiple top-level headings in one file, which should not have happened and is assumed by
pydata-sphinx-theme
when designing its heading styles. Also in this way the toctree will not show for instance 1.3.2, 1.3.1, 1.3.0, ..., but instead show only 1.3 which I think is desired.:titlesonly:
or:maxdepth: 1
would not work.pydata-sphinx-theme
has the left sidebar that shows the global toctree, this change would make the navigation much simpler.pydata-sphinx-theme
assumes one top-level heading per page when designing its heading styles, so this would become an issue.Other changes
Since we have a single top-level heading now, I moved some "global" information (i.e., not specific to some micro version) from under the first micro version (e.g. 1.3.0) to under the top-level heading (e.g. 1.3). These include: the changelog legend, the link to the release highlight example, and the contributor list. Also note that the titles of the changelog legend and the contributor list are made into
.. rubric::
to avoid them from appearing in the toctree. Rubrics in the current theme may not look outstanding enough, but withpydata-sphinx-theme
they definitely look good.