small updates related to numpydoc #157
Closed
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
|
The main advantage we have for our current project, is that sphinx doesn't get confused. Without numpydoc sphinx gets confused by the rst headers in the docstrings. What other reasons are there to use numpydoc? How to use numpydoc should perhaps be documented in doc/sphinxext/README.txt? What do you think? |
|
Something like that would be useful and then you could reference it. Also note the directions in HOWTO_BUILD_DOCS.rst, maybe a cross reference is all that is needed. I think the important thing is to make the information findable and maybe expand it a bit in light of your experience using it. |
|
@charris: i have addressed the issues above. I will now rebase this branch to make neat patches. |
Explain why it's good to use numpydoc and link to both numpydoc and some installation and usage instructions.
|
Merged in a2a9dfb..aded70c, thanks. |
|
Awesome thanks! |
luyahan
pushed a commit
to plctlab/numpy
that referenced
this pull request
Apr 25, 2024
feat: Add vaba_[s8|s16|s32|u8|u16|u32]
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.
Mention numpydoc.py in numpy docstring guidelines. This should make it easier for people to use the sphinx autodoc to generate API documentation from code that adheres to the numpy docstring conventions.
Also the URL given in the docstring of numpydoc.py was still pointing to the old scipy trac instance. Now points to the HOWTO on GitHub.