Support Sphinx / reStructuredText / reST args format
Open
Nobody has claimed this yet.
enhancement
good first issue
Hacktoberfest
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
def func(s, test):
"""
Returns `True` if the string length is greater than the given integer.
:param s: str
:param test: int
:return: bool
"""
pass
This is default docstring style used in many editors.
Expected Behavior
Something like that:
Actual Behavior
Additional info
- pdoc version: 0.6.3
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the pdoc 0.6.3 output for the sample func docstring containing :param and :return fields. Trace how pdoc parses and renders that docstring, then verify that Sphinx/reStructuredText argument documentation appears as shown in the expected screenshot.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100