BUG: Fix list of possible docstring section header patterns for global_enable_try_examples
#263
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.
Closes #256
This PR updates the list of section header patterns for determining the next section after the examples section to a list which should work for
sphinx.ext.napoleon
. It also updates the list of possiblenumpydoc
section patterns for correctness. The latter doesn't really matter that much though. Recent versions ofnumpydoc
are opinionated and will re-arrange headers to fit a preferred order, so most of these patterns will never be found after an examples section after preprocessing bynumpydoc
. It wasn't much extra work to include the correct pattern for all headings though.The core idea here is that
sphinx.ext.napoleon
andnumpydoc
each map human writable headers liketo directives and other forms of
rst
markup, and there are some differences in what they can output for different section headers, but this wasn't accounted for because I had only testedglobal_enable_try_examples
withnumpydoc
.sphinx.ext.napoleon
is also widely used though (e.g. Astropy, IPython, XArray) and should be supported.