Skip to content

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

Merged
timhoffm merged 3 commits into
matplotlib:mainfrom
jklymak:doc-use-mpl-sphinx
Oct 24, 2021
Merged

DOC: use mpl-sphinx-theme for navbar, social, logo#21429
timhoffm merged 3 commits into
matplotlib:mainfrom
jklymak:doc-use-mpl-sphinx

Conversation

@jklymak

@jklymak jklymak commented Oct 22, 2021

Copy link
Copy Markdown
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 (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • 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).
  • 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).

@jklymak jklymak added this to the v3.5.0 milestone Oct 22, 2021
@jklymak

jklymak commented Oct 22, 2021

Copy link
Copy Markdown
Member Author

(Note, probably not crucial for 3.5.0)

@jklymak
jklymak marked this pull request as draft October 22, 2021 10:44
@jklymak
jklymak force-pushed the doc-use-mpl-sphinx branch 3 times, most recently from 8a6d8b5 to 58da13c Compare October 22, 2021 14:38
@jklymak
jklymak marked this pull request as ready for review October 22, 2021 16:01
@jklymak

jklymak commented Oct 22, 2021

Copy link
Copy Markdown
Member Author

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

@jklymak
jklymak marked this pull request as draft October 23, 2021 06:50
@jklymak
jklymak force-pushed the doc-use-mpl-sphinx branch 2 times, most recently from ebfb905 to acaedac Compare October 23, 2021 11:29
@jklymak
jklymak marked this pull request as ready for review October 23, 2021 17:21
@jklymak
jklymak force-pushed the doc-use-mpl-sphinx branch from 2c1b72a to 3b406ff Compare October 24, 2021 08:25
@timhoffm

Copy link
Copy Markdown
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

jklymak commented Oct 24, 2021

Copy link
Copy Markdown
Member Author

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.

@timhoffm
timhoffm merged commit 4c71a1f into matplotlib:main Oct 24, 2021
@lumberbot-app

lumberbot-app Bot commented Oct 24, 2021

Copy link
Copy Markdown

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

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

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants