Skip to content

[Doc]: Spurious references from API to gallery examples #22036

Open
@StefRe

Description

@StefRe

Documentation Link

https://matplotlib.org/devdocs/api/_as_gen/matplotlib.axes.Axes.set_axis_off.html

Problem

My understanding is that the API reference should only include links to gallery examples if the given API function is listed in the .. admonition:: References block of the example, see documentation and e.g. #19233 (comment). However, links seem to be generated for any function in the example, see for instance set_axis_off where set_axis_off is included in the references list in only 2 of the 9 linked gallery examples. plot links to even 176 examples (there's hardly any example that's not linked to from there).

(this is kind of the reverse of #19715)

Suggested improvement

Add links only to those gallery examples that explicitly list the given function in their references block.

Matplotlib Version

3.6.0.dev888+g25a54a4fef.d20211129

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions