Skip to content

[DOC] Add top-level .. module:: definition for matplotlib #20062

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 1 commit into from
Apr 25, 2021

Conversation

adrn
Copy link
Contributor

@adrn adrn commented Apr 24, 2021

PR Summary

This PR adds a top-level Sphinx .. module:: definition for matplotlib to enable intersphinx links to the main matplotlib documentation, like :mod:matplotlib. This fixes #20061.

PR Checklist

  • [N/A] Has pytest style unit tests (and pytest passes).
  • Is Flake 8 compliant (run flake8 on changed files to check).
  • [N/A] New features are documented, with examples if plot related.
  • Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • [N/A] Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • [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).

@dstansby
Copy link
Member

Anyone can merge, but I'm out of the loop on backport branches at the moment, and unsure whether this should go to 3.4.2 or 3.4-doc.

@timhoffm timhoffm modified the milestones: v3.4.2, v3.4-doc Apr 25, 2021
@timhoffm
Copy link
Member

I think 3.4-doc because it does not touch any py files.

@timhoffm timhoffm merged commit 8188d31 into matplotlib:master Apr 25, 2021
@timhoffm
Copy link
Member

Thanks @adrn !

meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Apr 25, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Apr 25, 2021
timhoffm added a commit that referenced this pull request Apr 25, 2021
…062-on-v3.4.x

Backport PR #20062 on branch v3.4.x ([DOC] Add top-level .. module:: definition for matplotlib)
timhoffm added a commit that referenced this pull request Apr 25, 2021
…062-on-v3.4.1-doc

Backport PR #20062 on branch v3.4.1-doc ([DOC] Add top-level .. module:: definition for matplotlib)
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.

Intersphinx link to top-level matplotlib module not found (:mod:matplotlib)
3 participants