Skip to content

DOC: Bump to the sphinx-gallery release #21291

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

Merged
merged 1 commit into from
Oct 6, 2021

Conversation

QuLogic
Copy link
Member

@QuLogic QuLogic commented Oct 6, 2021

PR Summary

Now that it's out, we don't need to depend on a random commit.

PR Checklist

  • [n/a] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • [n/a] New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • [n/a] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [n/a] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

@greglucas
Copy link
Contributor

Also update environment.yml in the base of the repository?

Now that it's out, we don't need to depend on a random commit.
@QuLogic QuLogic force-pushed the sphinx-gallery-release branch from ce33c2e to 0fca630 Compare October 6, 2021 02:11
@QuLogic
Copy link
Member Author

QuLogic commented Oct 6, 2021

I always forget about that...

@@ -32,13 +32,10 @@ dependencies:
- scipy
- sphinx>=1.8.1,!=2.0.0
- sphinx-copybutton
- sphinx-gallery>=0.10
- pip
- pip:
Copy link
Contributor

Choose a reason for hiding this comment

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

We could put a cross-reference in the conda environment file so that only one location would be the source of truth.

Suggested change
- pip:
- pip:
- -r file:requirements/doc/doc-requirements.txt

Copy link
Member

Choose a reason for hiding this comment

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

I‘m somewhat sceptical on mixing conda and pip packages more than necessary. That could cause unnecessary dependency conflicts. If you think we need something better than manual syncing, please open an issue to discuss options.

@@ -32,13 +32,10 @@ dependencies:
- scipy
- sphinx>=1.8.1,!=2.0.0
- sphinx-copybutton
- sphinx-gallery>=0.10
- pip
- pip:
Copy link
Member

Choose a reason for hiding this comment

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

I‘m somewhat sceptical on mixing conda and pip packages more than necessary. That could cause unnecessary dependency conflicts. If you think we need something better than manual syncing, please open an issue to discuss options.

@timhoffm timhoffm merged commit 97ba9d4 into matplotlib:master Oct 6, 2021
@lumberbot-app
Copy link

lumberbot-app bot commented Oct 6, 2021

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 -m1 97ba9d41efaaf06351d3c531c20a9c448b682b40
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #21291: DOC: Bump to the sphinx-gallery release'
  1. Push to a named branch :
git push YOURFORK v3.5.x:auto-backport-of-pr-21291-on-v3.5.x
  1. Create a PR against branch v3.5.x, I would have named this PR:

"Backport PR #21291 on branch v3.5.x (DOC: Bump to the sphinx-gallery release)"

And apply the correct labels and milestones.

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

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

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

@QuLogic QuLogic deleted the sphinx-gallery-release branch October 6, 2021 20:17
QuLogic pushed a commit to QuLogic/matplotlib that referenced this pull request Oct 6, 2021
tacaswell added a commit that referenced this pull request Oct 7, 2021
…3.5.x

Backport PR #21291 on branch v3.5.x (DOC: Bump to the sphinx-gallery release)
tacaswell pushed a commit to tacaswell/matplotlib that referenced this pull request Oct 12, 2021
tacaswell pushed a commit that referenced this pull request Oct 20, 2021
DOC: Bump to the sphinx-gallery release
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.

4 participants