Skip to content

Non functional API links break docs builds downstream #14551

Closed

Description

@bsipocz

#12716 has added new "See Also" sections to docstrings with some of them containing non functional API links. When the Axes class is subclassed downsteam and thus method documentation is inherited, these links are causing failing docs builds.

Examples: https://matplotlib.org/3.1.0/api/_as_gen/matplotlib.axes.Axes.get_tightbbox.html#matplotlib.axes.Axes.get_tightbbox

Sphinx and numpydoc recently became significantly stricter, it may be a reason why it doesn't yet cause issues for your doc testing using pinned version of Sphinx.

Activity

  1. added this to the v3.1.2 milestone on Jun 14, 2019
  2. alexrudy commented on Jul 13, 2019

    @alexrudy
    Contributor

    I tried to fix this in #14764

  3. QuLogic commented on Jul 17, 2019

    @QuLogic
    Member

    This should be fixed by the above PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions