Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

DOC: use mpl-sphinx-theme for navbar, social, logo#21429

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Merged
timhoffm merged 3 commits intomatplotlib:mainfromjklymak:doc-use-mpl-sphinx
Oct 24, 2021

Conversation

jklymak
Copy link
Member

PR Summary

Switches main site to use mpl-sphinx-theme

Note at some point we need to consider pinning this for releases.

PR Checklist

  • Has pytest style unit tests (andpytest passes).
  • IsFlake 8 compliant (runflake8 on changed files to check).
  • New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs shouldbuild without error).
  • Conforms to Matplotlib style conventions (installflake8-docstrings and runflake8 --docstring-convention=all).
  • New features have an entry indoc/users/next_whats_new/ (follow instructions in README.rst there).
  • API changes documented indoc/api/next_api_changes/ (follow instructions in README.rst there).

@jklymak
Copy link
MemberAuthor

(Note, probably notcrucial for 3.5.0)

@jklymakjklymak marked this pull request as draftOctober 22, 2021 10:44
@jklymakjklymakforce-pushed thedoc-use-mpl-sphinx branch 3 times, most recently from8a6d8b5 to58da13cCompareOctober 22, 2021 14:38
@jklymakjklymak marked this pull request as ready for reviewOctober 22, 2021 16:01
@jklymak
Copy link
MemberAuthor

This works now - mol-sphinx-theme had a bug...

@jklymakjklymak marked this pull request as draftOctober 23, 2021 06:50
@jklymakjklymakforce-pushed thedoc-use-mpl-sphinx branch 2 times, most recently fromebfb905 toacaedacCompareOctober 23, 2021 11:29
@jklymakjklymak marked this pull request as ready for reviewOctober 23, 2021 17:21
@timhoffm
Copy link
Member

The only disadvatage I see with this concept is that we don't see how the resulting pages look like when changing the mpl-sphinx-theme. After updating the theme, all downstream sites have to be rebuilt as well.

@jklymak
Copy link
MemberAuthor

Mpl-Sphinx-theme has a doc build. These docs are built at release time, and devdocs are built periodically. The other docs are built when changed, but we could also add a "daily" build to them all.

@timhoffmtimhoffm merged commit4c71a1f intomatplotlib:mainOct 24, 2021
@lumberbot-app
Copy link

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 4c71a1f0a3f5beb498795ed9c6ea27b0be34db98
  1. You will likely have some merge/cherry-pick conflict here, fix them and commit:
$ git commit -am 'Backport PR #21429: DOC: use mpl-sphinx-theme for navbar, social, logo'
  1. Push to a named branch :
git push YOURFORK v3.5.x:auto-backport-of-pr-21429-on-v3.5.x
  1. Create a PR against branch v3.5.x, I would have named this PR:

"Backport PR#21429 on branch v3.5.x (DOC: use mpl-sphinx-theme for navbar, social, logo)"

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 removeStill Needs Manual Backport label once the PR gets merged.

If these instruction are inaccurate, feel free tosuggest an improvement.

jklymak pushed a commit to jklymak/matplotlib that referenced this pull requestOct 25, 2021
DOC: use mpl-sphinx-theme for navbar, social, logo
jklymak pushed a commit to jklymak/matplotlib that referenced this pull requestOct 25, 2021
DOC: use mpl-sphinx-theme for navbar, social, logo
@jklymakjklymak deleted the doc-use-mpl-sphinx branchOctober 25, 2021 12:13
timhoffm added a commit that referenced this pull requestOct 26, 2021
Backport#21429 from jklymak/doc-use-mpl-sphinx
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment
Reviewers

@timhoffmtimhoffmtimhoffm approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
v3.5.0
Development

Successfully merging this pull request may close these issues.

5 participants
@jklymak@timhoffm@tacaswell@sandrotosi@QuLogic

[8]ページ先頭

©2009-2025 Movatter.jp