matplotlib / matplotlib/sampledoc

use the numpydoc package instead of bundling a numpydoc.py file

Open
#11 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
CSS
Stars
43
Forks
89
PR merge metrics
No merged PRs in 30d

Description

numpydoc is now its own project which can be installed with pip or other OS/distribution package managers. Would make sense to remove sphinxext/numpydoc.py from sampledoc?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by inspecting sphinxext/numpydoc.py and the project’s installation setup. Remove the bundled module in favor of the external numpydoc package, then verify that sampledoc still provides its documentation functionality without the copied file.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Refactor
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.