A docutils directive to parse Numpy docstrings into valid reST.
Registered by
David Huard
1. A NumpyDocParser class that accepts a docstring following the Numpy standard docstring format and returns valid reST.
2. Docutils directive using the NumpyDocParser to return valid reST from a function docstring: numpyfunction and autonumpyfunction.
3. A Sphinx extension implementing those directives.
Blueprint information
- Status:
- Not started
- Approver:
- Stefan van der Walt
- Priority:
- Undefined
- Drafter:
- David Huard
- Direction:
- Needs approval
- Assignee:
- David Huard
- Definition:
- New
- Series goal:
- None
- Implementation:
- Unknown
- Milestone target:
- None
- Started by
- Completed by
Related branches
Related bugs
Sprints
Whiteboard
(?)