numpydoc

Numpy's Sphinx extensions

https://github.com/numpy/numpydoc

Science Score: 36.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
6 of 86 committers (7.0%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (7.2%) to scientific vocabulary

Keywords from Contributors

closember qt wx tk gtk alignment flexible cython notebook cpython

Last synced: 6 months ago · JSON representation

Repository

Numpy's Sphinx extensions

Basic Info

Host: GitHub
Owner: numpy
License: other
Language: Python
Default Branch: main
Homepage: https://numpydoc.readthedocs.io/
Size: 815 KB

Statistics

Stars: 335
Watchers: 31
Forks: 168
Open Issues: 126
Releases: 21

Created over 12 years ago · Last pushed 6 months ago

Metadata Files

Readme License

README.rst

=====================================
numpydoc -- Numpy's Sphinx extensions
=====================================

.. image:: https://readthedocs.org/projects/numpydoc/badge/?version=latest
   :alt: Documentation Status
   :target: https://numpydoc.readthedocs.io/en/latest/

.. image:: https://codecov.io/gh/numpy/numpydoc/branch/main/graph/badge.svg
   :target: https://app.codecov.io/gh/numpy/numpydoc/branch/main

.. image:: https://github.com/numpy/numpydoc/actions/workflows/test.yml/badge.svg?branch=main
   :target: https://github.com/numpy/numpydoc/actions/workflows/test.yml

This package provides the ``numpydoc`` Sphinx extension for handling
docstrings formatted according to the NumPy documentation format.
The extension also adds the code description directives
``np:function``, ``np-c:function``, etc.

numpydoc requires Python 3.9+ and sphinx 6+.

For usage information, please refer to the `documentation
`_.

The `numpydoc docstring guide
`_ explains how
to write docs formatted for this extension, and the `user guide
`_ explains how to use it with Sphinx.

Owner

Name: NumPy
Login: numpy
Kind: organization

Website: http://www.numpy.org/
Repositories: 31
Profile: https://github.com/numpy

GitHub Events

Total

Issues event: 26
Watch event: 37
Delete event: 8
Issue comment event: 108
Push event: 26
Pull request review comment event: 26
Pull request review event: 46
Pull request event: 55
Fork event: 11
Create event: 10

Last Year

Issues event: 26
Watch event: 37
Delete event: 8
Issue comment event: 108
Push event: 26
Pull request review comment event: 26
Pull request review event: 46
Pull request event: 55
Fork event: 11
Create event: 10

Committers

Last synced: 8 months ago

All Time

Total Commits: 578
Total Committers: 86
Avg Commits per committer: 6.721
Development Distribution Score (DDS): 0.766

Past Year

Commits: 47
Committers: 14
Avg Commits per committer: 3.357
Development Distribution Score (DDS): 0.66

Top Committers

Name	Email	Commits
Jarrod Millman	j**n@g**m	135
Joel Nothman	j**n@g**m	69
Pauli Virtanen	p**v@i**i	63
Ross Barnowski	r**r@b**u	38
Eric Larson	l**d@g**m	37
Ralf Gommers	r**s@g**m	22
Charles Harris	c**s@g**m	15
Stefanie Molin	2****n	12
pre-commit-ci[bot]	6****]	12
dependabot[bot]	4****]	9
Matthias Bussonnier	b**s@g**m	9
Joris Van den Bossche	j**e@g**m	8
Andreas Mueller	t**t@g**m	8
chebee7i	c**i@g**m	7
Mike Taves	m**s@g**m	7
Thomas Kluyver	t**l@g**m	5
Thomas A Caswell	t**l@g**m	5
Hassan Kibirige	h**1@g**m	4
Dimitri Papadopoulos Orfanos	3****s	4
Lucas Colley	l**8@g**m	4
Paul van Mulbregt	p****t	4
Antony Lee	a**e@g**m	4
Stefan van der Walt	s**v@b**u	4
Sergio Callegari	s**i@u**t	4
Julien Schueller	s**r@p**m	3
Matti Picus	m**s@g**m	3
Nelle Varoquaux	n**x@g**m	3
Daniel McCloy	d**n@m**o	3
Brigitta Sipőcz	b**z@g**m	3
Raghav R V	r**v@g**m	3
and 56 more...

Committer Domains (Top 20 + Academic)

berkeley.edu: 2 iki.fi: 1 unibo.it: 1 phimeca.com: 1 mccloy.info: 1 diebolt.io: 1 pm.me: 1 esciencecenter.nl: 1 laxalde.org: 1 lbl.gov: 1 fperez.org: 1 yahoo.de: 1 cfa.harvard.edu: 1 student.ethz.ch: 1 ensta.org: 1 relentlessidiot.com: 1 mailbox.org: 1 cadair.com: 1 gmx.de: 1 eddiehebert.com: 1 calpoly.edu: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 102
Total pull requests: 254
Average time to close issues: 4 months
Average time to close pull requests: 6 days
Total issue authors: 68
Total pull request authors: 36
Average comments per issue: 2.89
Average comments per pull request: 1.27
Merged pull requests: 192
Bot issues: 0
Bot pull requests: 37

Past Year

Issues: 25
Pull requests: 61
Average time to close issues: 21 days
Average time to close pull requests: 7 days
Issue authors: 19
Pull request authors: 15
Average comments per issue: 1.08
Average comments per pull request: 0.92
Merged pull requests: 36
Bot issues: 0
Bot pull requests: 22

View more stats

Top Authors

Issue Authors

jarrodmillman (9)
HealthyPear (7)
lucascolley (4)
KendrickLamarck (3)
stefmolin (3)
kloczek (3)
stefanv (3)
mattgebert (2)
oscargus (2)
sdiebolt (2)
sergiocallegari (2)
jorgepiloto (2)
crusaderky (2)
mscheltienne (2)
rossbar (2)

Pull Request Authors

jarrodmillman (94)
dependabot[bot] (20)
stefmolin (18)
pre-commit-ci[bot] (17)
rossbar (14)
mwtoews (10)
larsoner (9)
lucascolley (8)
Carreau (7)
mattgebert (6)
bsipocz (6)
stefanv (6)
drammock (4)
cmarmo (4)
namurphy (3)

Top Labels

Issue Labels

bug (2) maintenance (2) enhancement (1) needs-decision (1) invalid (1) question (1) type: Bug fix (1) type: Maintenance (1) type: Enhancement (1) help-wanted (1)

Pull Request Labels

type: Maintenance (113) type: Enhancement (22) type: Bug fix (21) type: Documentation (20) maintenance (18) bug (2) enhancement (1)

Packages

Total packages: 5
Total downloads:
- pypi 1,274,853 last-month
Total docker downloads: 14,054,983

Total dependent packages: 1,044
(may contain duplicates)
Total dependent repositories: 15,388
(may contain duplicates)
Total versions: 79
Total maintainers: 6

pypi.org: numpydoc

Sphinx extension to support docstrings in Numpy format

Homepage: https://numpydoc.readthedocs.io
Documentation: https://numpydoc.readthedocs.io/
License: Copyright (C) 2008-2023 Stefan van der Walt <stefan@mentat.za.net>, Pauli Virtanen <pav@iki.fi> Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Latest release: 1.9.0
published 8 months ago

Versions: 34
Dependent Packages: 1,005
Dependent Repositories: 13,974
Downloads: 1,274,853 Last month
Docker Downloads: 14,054,983

Rankings

Dependent packages count: 0.0%

Dependent repos count: 0.1%

Downloads: 0.4%

Docker downloads count: 0.6%

Average: 1.5%

Forks count: 4.0%

Stargazers count: 4.0%

Maintainers (5)

Eric89GXL pv rgommers jarrodmillman jnothman

Last synced: 6 months ago

proxy.golang.org: github.com/numpy/numpydoc

Documentation: https://pkg.go.dev/github.com/numpy/numpydoc#section-documentation
License: other
Latest release: v1.9.0
published 8 months ago

Versions: 17
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Forks count: 1.4%

Stargazers count: 2.1%

Average: 5.0%

Dependent packages count: 7.0%

Dependent repos count: 9.3%

Last synced: 6 months ago

spack.io: py-numpydoc

numpydoc - Numpy's Sphinx extensions

Homepage: https://github.com/numpy/numpydoc
License: []
Latest release: 1.5.0
published over 2 years ago

Versions: 3
Dependent Packages: 6
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Average: 7.6%

Dependent packages count: 8.4%

Forks count: 8.6%

Stargazers count: 13.5%

Maintainers (1)

adamjstewart

Last synced: 6 months ago

conda-forge.org: numpydoc

Homepage: https://github.com/numpy/numpydoc
License: BSD-3-Clause
Latest release: 1.5.0
published over 3 years ago

Versions: 13
Dependent Packages: 29
Dependent Repositories: 707

Rankings

Dependent repos count: 1.0%

Dependent packages count: 2.3%

Average: 10.7%

Forks count: 15.1%

Stargazers count: 24.5%

Last synced: 6 months ago

anaconda.org: numpydoc

Numpy's documentation uses several custom extensions to Sphinx. These are shipped in this numpydoc package, in case you want to make use of them in third-party projects. The numpydoc extension provides support for the Numpy docstring format in Sphinx, and adds the code description directives np:function, np-c:function, etc. that support the Numpy docstring syntax.

Homepage: https://github.com/numpy/numpydoc
License: BSD-2-Clause
Latest release: 1.9.0
published 8 months ago

Versions: 12
Dependent Packages: 4
Dependent Repositories: 707

Rankings

Dependent repos count: 5.7%

Dependent packages count: 11.1%

Average: 20.3%

Forks count: 27.1%

Stargazers count: 37.2%

Last synced: 6 months ago

Dependencies

requirements/developer.txt pypi

pre-commit >=2.19

requirements/test.txt pypi

matplotlib *
pytest *
pytest-cov *

setup.py pypi

sphinx >=3.0

.github/workflows/lint.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
pre-commit/action v3.0.0 composite

.github/workflows/main.yml actions

larsoner/circleci-artifacts-redirector-action master composite

.github/workflows/test.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

requirements/doc.txt pypi

matplotlib >=3.5
numpy >=1.21
pydata-sphinx-theme >=0.11
sphinx >=5.2