8000 Add autoclass entry for Artist API doc. · matplotlib/matplotlib@815421b · GitHub
[go: up one dir, main page]

Skip to content

Commit 815421b

Browse files
committed
Add autoclass entry for Artist API doc.
Adding an autoclass entry in the Artist API ensures that that class appears in the intersphinx `build/html/object.inv`, as can be checked by ``` "matplotlib.artist.Artist" in ( sphinx.ext.intersphinx.read_inventory( open("build/html/objects.inv", "rb"), None, lambda *args: None)[ "py:class"]) ``` (now returns True). This all 8000 ows other projects to link to that class in their docs using ``` `Artist` <matplotlib.artist.Artist> ``` This possibility used to be present, but disappeared when the Artist API doc got refactored. (Other classes that appear in the API docs are fine as they already use autoclass.)
1 parent 72cea62 commit 815421b

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

doc/api/artist_api.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
``Artist`` class
1717
================
1818

19+
.. autoclass:: Artist
1920

2021
Interactive
2122
-----------

0 commit comments

Comments
 (0)
0