Support for mando, ReST, Numpy, and Google docstrings #24
Conversation
This file contains 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
Support for Google and Numpy docstrings is handled via conversion to ReST docstrings using functions from sphinx.ext.napoleon. These changes also remove from docstrings the sphinx fieldlists that mando doesn't use. Simple tests for Google and Numpy docstrings are included.
|
Amazing work, Tim! Thank you for adding these features. I'll improve the README and the docs explaining all the supported formats. |
rubik
added a commit
that referenced
this pull request
Mar 10, 2016
feat(core): add support for mando, ReST, Numpy, and Google docstrings
This was referenced Mar 10, 2016
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.
Support for Numpy and Google formatted docstrings by conversion to ReST using sphinx.ext.napoleon. Trim out unused field lists from ReST to make mando formatted docstring.