Repository navigation
DOC: tweak template to use automodule (not currentmodule) - #9386
Merged
Merged
Conversation
This ensure that the module gets created a link target added. The trick is tell `automodule` to not document members. This is slightly better than using the `module` directive as it at least pulls the docstring.
anntzer
previously requested changes
Oct 13, 2017
anntzer
left a comment
anntzer
left a comment
Contributor
There was a problem hiding this comment.
Result looks a bit weird? https://2168-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/api/index.html (scroll to bottom)
Member
Author
|
Compare to http://matplotlib.org/api/index.html At least now the link is live! |
Contributor
|
Indeed. But can you not put the link on http://matplotlib.org/api/pyplot_summary.html instead? |
Member
Author
|
Yes, that is probably a better place for that. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This ensure that the module gets created a link target added. The
trick is tell
automoduleto not document members.This is slightly better than using the
moduledirective as it atleast pulls the docstring.
closes #9331
PR Summary
PR Checklist