Skip to content
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

Add initial Sphinx docs #174

Merged
merged 5 commits into from
Sep 14, 2022
Merged

Add initial Sphinx docs #174

merged 5 commits into from
Sep 14, 2022

Conversation

ConorMacBride
Copy link
Member

@ConorMacBride ConorMacBride commented Jul 3, 2022

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 at https://matplotlib.org/pytest-mpl/latest/ on every push to the main 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

Copy link
Contributor

@Cadair Cadair left a comment

Choose a reason for hiding this comment

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

This looks good. Beyond my general disdain for reimplementing RTD with gh-pages I think we can ship this?

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.

Adopt Sphinx and RTD
2 participants