Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Restore matplotlib.__doc__ in Sphinx docs #23404

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 2 commits into from
Jul 30, 2022
Merged

Conversation

QuLogic
Copy link
Member

@QuLogic QuLogic commented Jul 9, 2022

PR Summary

Since we already have an explicit listing of module members, that needs to be turned off here. Also, don't add it to the index as we already have matplotlib pointing to the top level page (though maybe that should change?)

Fixes #17973

PR Checklist

Tests and Styling

  • [n/a] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (install flake8-docstrings and run flake8 --docstring-convention=all).

Documentation

  • [n/a] New features are documented, with examples if plot related.
  • [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).
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).

Since we already have an explicit listing of module members, that needs
to be turned off here. Also, don't add it to the index as we already
have `matplotlib` pointing to the top level page (though maybe that
should change?)

Fixes matplotlib#17973
@QuLogic QuLogic added this to the v3.6.0 milestone Jul 9, 2022
@tacaswell
Copy link
Member

Looks good except the last module entry renders differently

image

I'm going to push another commit to this to fix this is a different way.

@QuLogic QuLogic merged commit 87595b9 into matplotlib:main Jul 30, 2022
@QuLogic QuLogic deleted the init-docs branch July 30, 2022 00:23
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.

DOC: matplotlib.__doc__ not included in online docs ?
2 participants