Add autoclass entry for Artist API doc. #8175
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 allows 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.)
tacaswell
approved these changes
Mar 1, 2017
|
Sorry I broke this. |
|
Thanks @anntzer ! |
dstansby
pushed a commit
that referenced
this pull request
Mar 25, 2017
Add autoclass entry for Artist API doc.
|
Backported to |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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(now returns True).
This allows other projects to link to that class in their docs using
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.)
The relevant section is now rendered as
