-
Notifications
You must be signed in to change notification settings - Fork 8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Sphinx #264
Merged
Merged
Sphinx #264
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
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.
Switch to sphinx pydata theme.
Adding some notes here on the docstrings parsers:
numpydoc
for docstrings parsing; we are using another sphinx extension callednapoleon
.numpydoc
works best in parsing, way less unexpected rendering (for example, multi-line exceptions renders fine), but it doesn't support type hinting (type hinting are dropped). This is because numpy doesn't support type hinting too (see here for a discussion: Support type annotations (PEP 484) numpy/numpydoc#196). In the future this may change and I will strongly recommend to switch tonumpydoc
. Napoleon has a clear bug insphinx/ext/napoleon/docstring.py
:but I don't know what to do about it. For now, I split the exception into multiple (i.e. a ValueError with few cases, is split into multiple errors of one case).