Integration into Sphinx
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 355
- Forks
- 181
- Avg merge
- 1d 9h
- Merged PRs (30d)
- 3
Description
Hello,
A brief request for feedback and a question:
- What could Sphinx do to make things easier for numpydoc? (If nothing: great!)
- Are there any parts of numpydoc that it would make sense to be integrated into core Sphinx? For example, improving
sphinx.ext.napoleon.
Thanks,
Adam
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
Review how numpydoc currently relates to Sphinx, especially the referenced sphinx.ext.napoleon extension. Identify concrete improvements or functionality that could move into Sphinx, then document the candidate integration points and obtain agreement on scope; done means a decided, actionable integration plan.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100