Skip to content

[Doc]: No mini-galleries created for explicit backreferences with default role #25595

@StefRe

Description

@StefRe

Documentation Link

https://matplotlib.org/devdocs/devel/documenting_mpl.html#references-for-sphinx-gallery

Problem

The Writing Documentation guide advises for Sphinx galleries that the showcased functions be listed in an admonition in the form `matplotlib.axes.Axes.fill`, i.e. without a preceding role qualifier using the default role (obj). This is, however, without any effect, as Sphinx gallery only considers links with one of the five roles mentioned in their documentation.

It doesn't catch one's eye as the functions used in the code of the examples are implicitly back-referenced - be there an admonition or not. You can see it, however, at the pyplot equivalents for OO examples (e.g. pyplot.bar_label doesn't refer to the Grouped bar chart with labels example) or the OO equivalents for pyplot examples (e.g. matplotlib.axes.Axes.axline doesn't refer to the Infinite lines example)

Suggested improvement

Should be fixed in Sphinx-Galleries.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions