Move setup of autosummary earlier in setup(). #191
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
`setup()` calls `app.setup_extension('sphinx.ext.autosummary')` so that
end users who add numpydoc to their extension list don't need to declare
a dependency on autosummary, but we may just as well move the call to
setup_extension even earlier, which also removes the need to declare a
dependency on autodoc (as autosummary will initialize it).
Otherwise, users need to be careful to have autodoc *before* numpydoc
in their extension list; without that they get an "Unknown event name:
autodoc-process-docstring" error.
|
kindly bumping |
jnothman
approved these changes
Jan 2, 2019
|
Thanks. |
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.
setup()callsapp.setup_extension('sphinx.ext.autosummary')so thatend users who add numpydoc to their extension list don't need to declare
a dependency on autosummary, but we may just as well move the call to
setup_extension even earlier, which also removes the need to declare a
dependency on autodoc (as autosummary will initialize it).
Otherwise, users need to be careful to have autodoc before numpydoc
in their extension list; without that they get an "Unknown event name:
autodoc-process-docstring" error.