Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds an initial version of the pytest-mpl Sphinx docs. There's still a lot of things to change, but might be good to get an initial
latest
version published. It uses matplotlib sphinx theme. The content all mostly copied and pasted from the current readme.I've added a custom sphinx plugin for generating the HTML summaries of some of our tests and including them in the documentation similar to https://macbride.me/pytest-mpl/. Also added a custom plugin to make some fixes to the sidebar, although we should probably upstream that to the matplotlib sphinx theme eventually, as it will be useful to other non-native doc sites.
MetPy has some amazing infrastructure for publishing versioned Sphinx docs. Hope you don't mind, I've included a simplified workflow based on that in this PR, although maybe we should include some of the more complicated version publishing automations, or just manually edit the
gh-pages
branch on every release? I currently have it set make the docs available athttps://matplotlib.org/pytest-mpl/latest/
on every push to themain
branch, with no special treatment of tags.You can see what the docs currently look like here: https://macbride.me/pytest-mpl/latest/index.html
Closes #157