8000 DOC: Fix version switcher links to documentation by melissawm · Pull Request #23225 · matplotlib/matplotlib · GitHub
[go: up one dir, main page]
Skip to content

DOC: Fix version switcher links to documentation #23225

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
Merged
merged 3 commits into from
Jun 9, 2022
Merged

DOC: Fix version switcher links to documentation #23225

merged 3 commits into from
Jun 9, 2022

Conversation

melissawm
Copy link
Member

PR Summary

Closes #23193 by adding a URL field to the version switcher json file. This is new in pydata-sphinx-theme

PR Checklist

Tests and Styling

  • Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • New features are documented, with examples if plot related.
  • New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

github-actions[bot]
github-actions bot reviewed Jun 8, 2022
View reviewed changes
Copy link
@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

@melissawm
Copy link
Member Author

I'm not sure I understand the CI failures, unfortunately.

@matthewfeickert matthewfeickert mentioned this pull request Jun 9, 2022
Merged
1 task
@greglucas
Copy link
Contributor

It looks like the pydata theme also deprecated the logo link and replaced it with a logo dictionary that can be filled now.
https://pydata-sphinx-theme.readthedocs.io/en/stable/user_guide/configuring.html?highlight=logo#customize-logo-link

So, I think this needs to be updated to that new format:

matplotlib/doc/conf.py

Line 332 in c7defd7

"logo_link": "index",

@tacaswell
Copy link
Member

I think the other change is pydata/pydata-sphinx-theme#698 I'll push a commit.

Do we need to pin pydata-sphinx very far forward (or back)? On one hand it is a pure-python doc-build-only dependency, on the other adding / changing dependencies on the docs builds can still be harsh on our down-stream packagers.

@tacaswell tacaswell modified the milestones: v3.5.3, v3.5-doc Jun 9, 2022
@jklymak jklymak added the Documentation: website layout/behavior/styling changes label Jun 9, 2022
@jklymak
Copy link
Member
jklymak commented Jun 9, 2022

Looks like we will have to update the CSS, probably in mpl-sphinx-theme to get back the 'C0' section headers.

Newlook

@timhoffm timhoffm merged commit 0ebff50 into matplotlib:main Jun 9, 2022
@lumberbot-app
Copy link
lumberbot-app bot commented Jun 9, 2022

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.5.x
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 0ebff5006cc818eeb2c627d4726f41323073f7ce
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #23225: DOC: Fix version switcher links to documentation'
  1. Push to a named branch:
git push YOURFORK v3.5.x:auto-backport-of-pr-23225-on-v3.5.x
  1. Create a PR against branch v3.5.x, I would have named this PR:

"Backport PR #23225 on branch v3.5.x (DOC: Fix version switcher links to documentation)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@lumberbot-app
Copy link
lumberbot-app bot commented Jun 9, 2022

Owee, I'm MrMeeseeks, Look at me.

There seem to be a conflict, please backport manually. Here are approximate instructions:

  1. Checkout backport branch and update it.
git checkout v3.5.2-doc
git pull
  1. Cherry pick the first parent branch of the this PR on top of the older branch:
git cherry-pick -x -m1 0ebff5006cc818eeb2c627d4726f41323073f7ce
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
git commit -am 'Backport PR #23225: DOC: Fix version switcher links to documentation'
  1. Push to a named branch:
git push YOURFORK v3.5.2-doc:auto-backport-of-pr-23225-on-v3.5.2-doc
  1. Create a PR against branch v3.5.2-doc, I would have named this PR:

"Backport PR #23225 on branch v3.5.2-doc (DOC: Fix version switcher links to documentation)"

And apply the correct labels and milestones.

Congratulations — you did some good work! Hopefully your backport PR will be tested by the continuous integration and merged soon!

Remember to remove the Still Needs Manual Backport label once the PR gets merged.

If these instructions are inaccurate, feel free to suggest an improvement.

@melissawm
Copy link
Member Author

Thanks folks! Let me know if there's any follow up I can pick up.

@jklymak
Copy link
Member
jklymak commented Jun 9, 2022

pydata-sphinx-theme 0.9.0 has some pretty major changes in how css gets handled, most of which are marked as beta. I'm not sure we should be switching to it just yet. Probably discuss at matplotlib/mpl-sphinx-theme#32

@QuLogic QuLogic modified the milestones: v3.5-doc, v3.6.0 Jun 25, 2022
@oscargus oscargus mentioned this pull request Sep 1, 2022
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@timhoffm timhoffm timhoffm approved these changes

Assignees
No one assigned
Labels
Documentation: website layout/behavior/styling changes
Projects
None yet
Milestone
v3.6.0
Development

Successfully merging this pull request may close these issues.

[Doc]: Version switcher links broken
6 participants
@melissawm @greglucas @tacaswell @jklymak @timhoffm @QuLogic
0