added spinix.ext.napoleon to sphinx extensions #5
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.
I recently used this cookie cutter template having seen it in action at the SeptemRSE conference. I then spent three weeks trying to make sphinx work with my code (I have never used sphinx before). It turned out a particular doc-string in pandas.core.frame doesn't play nicely with numpydoc unless you have the
sphinx.ext.napoleon
extension enabled.Given that a lot of scientific python projects will probably use pandas DataFrames, and that many of the people you want to use this cookie cutter template may not have used sphinx before, this PR adds the extension to the list in
docs/source/conf.py
to save them the pain.