This repository was archived by the owner on Nov 23, 2024. It is now read-only.
This repository was archived by the owner on Nov 23, 2024. It is now read-only.
Support common documentation formats #14
Closed as not planned
Description
- Refactor NumpyDocParser to use docstring-parser
- Support Google docstrings #19
- Support reStructuredText docstrings #18
- Support epytext docstrings #17
- Flag to choose between different documentation formats #16
- Auto-Detect documentation format #15
- For
__init__
parameters in NumPyDoc: Look up documentation either on__init__
or containing class #10
Additional Context
- Examples of the different formats: https://realpython.com/documenting-python-code/#google-docstrings-example
pyment
can detect the used documentation format: https://github.com/dadadel/pyment/blob/2c10b1c64093adbce8db369a3db4321e6c3c7c32/pyment/docstring.py#L647pdoc
might also be helpful for this, particularly the conversion from a docstring format to Markdown: https://pdoc.dev/docs/pdoc/docstrings.html- docstring_parser seems to be exactly what we are looking for
Metadata
Metadata
Assignees
Type
Projects
Status
✔️ Done