https://github.com/astropy/sphinx-automodapi

Sphinx extension for generating API documentation

Science Score: 59.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
Found 3 DOI reference(s) in README
✓
Academic publication links
Links to: zenodo.org
✓
Committers with academic emails
4 of 36 committers (11.1%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (12.1%) to scientific vocabulary

Keywords

documentation python sphinx

Keywords from Contributors

astronomy astrophysics astropy wx tk qt gtk closember astropy-affiliated solar

Last synced: 5 months ago · JSON representation

Repository

Sphinx extension for generating API documentation

Basic Info

Host: GitHub
Owner: astropy
License: bsd-3-clause
Language: Python
Default Branch: main
Homepage: https://sphinx-automodapi.readthedocs.io
Size: 569 KB

Statistics

Stars: 66
Watchers: 7
Forks: 48
Open Issues: 51
Releases: 8

Topics

documentation python sphinx

Created over 9 years ago · Last pushed 6 months ago

Metadata Files

Readme Changelog License

README.rst

|DOI| |PyPI| |Docs| |CI Status| |Coverage Status|

About
=====

This is a Sphinx extension to automatically generate API pages for whole
modules. It was originally developed for the Astropy project but is now
available as a standalone package since it can be used for any other
package. The documentation can be found on
`ReadTheDocs `_.

Running tests
-------------

To run the tests, you can either do::

    pytest sphinx_automodapi

or if you have `tox `_ installed::

    tox -e test

.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5799977.svg
  :target: https://doi.org/10.5281/zenodo.5799977
.. |PyPI| image:: https://img.shields.io/pypi/v/sphinx-automodapi.svg
  :target: https://pypi.python.org/pypi/sphinx-automodapi
.. |Docs| image:: https://readthedocs.org/projects/sphinx-automodapi/badge/?version=latest
    :target: https://sphinx-automodapi.readthedocs.io/en/latest/?badge=latest
.. |CI Status| image:: https://github.com/astropy/sphinx-automodapi/workflows/CI/badge.svg
  :target: https://github.com/astropy/sphinx-automodapi/actions
.. |Coverage Status| image:: https://codecov.io/gh/astropy/sphinx-automodapi/branch/main/graph/badge.svg
  :target: https://codecov.io/gh/astropy/sphinx-automodapi

Development status
------------------

Due to the limitations of FOSS development model, the Astropy Project
does not have enough bandwidth to add new features or fixes to this
package beyond what is necessary for the project itself. Therefore,
we apologize for any inconvenience caused by unresolved open issues
and unmerged stale pull requests. If you have any questions or concerns,
please contact the project via https://www.astropy.org/help .
Thank you for your interest in this package!

Owner

Name: The Astropy Project
Login: astropy
Kind: organization

Website: http://www.astropy.org
Repositories: 88
Profile: https://github.com/astropy

GitHub Events

Total

Create event: 10
Release event: 2
Issues event: 10
Watch event: 3
Delete event: 8
Issue comment event: 63
Push event: 21
Pull request review comment event: 13
Pull request review event: 30
Pull request event: 33
Fork event: 4

Last Year

Create event: 10
Release event: 2
Issues event: 10
Watch event: 3
Delete event: 8
Issue comment event: 63
Push event: 21
Pull request review comment event: 13
Pull request review event: 30
Pull request event: 33
Fork event: 4

Committers

Last synced: 8 months ago

All Time

Total Commits: 480
Total Committers: 36
Avg Commits per committer: 13.333
Development Distribution Score (DDS): 0.596

Past Year

Commits: 45
Committers: 7
Avg Commits per committer: 6.429
Development Distribution Score (DDS): 0.6

Top Committers

Name	Email	Commits
Thomas Robitaille	t**e@g**m	194
Erik Tollerud	e**d@g**m	66
P. L. Lim	2****m	48
Brigitta Sipőcz	b**z@g**m	45
E. Madison Bray	e**y@g**m	27
Erik Everson	e**n@g**m	13
Marco Rossi	d**r@m**m	12
dependabot[bot]	4****]	9
Simon Conseil	c**t@s**g	8
Hans Moritz Günther	m**r@g**e	6
William Jamieson	w**m@j**d	5
Adrian Price-Whelan	a**w@g**m	5
Kyle D Fawcett	k**t@m**g	5
Michael Droettboom	m**m@g**m	4
Marten van Kerkwijk	m**k@a**a	3
Stuart Mumford	s**t@c**m	3
Ed Slavich	e**h@s**u	2
csaba.nemes	c**s@t**m	2
Albert Y. Shih	a**h@g**m	2
Christoph Deil	D**h@g**m	2
Leo Singer	l**r@l**g	2
Joseph Martinot-Lagarde	j**e@o**r	2
Conor MacBride	c**r@m**e	2
David Pérez-Suárez	d**o@g**m	1
Jai Ram Rideout	j**t@g**m	1
Jordan Cook	j**k@p**m	1
Kyle Barbary	k**y@g**m	1
Larry Bradley	l**y@g**m	1
Luke Davis	l**d@g**m	1
MartinHjelmare	m**2@k**e	1
and 6 more...

Committer Domains (Top 20 + Academic)

powertools-tech.com: 1 fis.ucm.es: 1 newton.cx: 1 kth.se: 1 pioneer.com: 1 macbride.me: 1 onera.fr: 1 ligo.org: 1 thyssenkrupp.com: 1 stsci.edu: 1 cadair.com: 1 astro.utoronto.ca: 1 mitre.org: 1 jamieson.phd: 1 gmx.de: 1 saimon.org: 1 marco-rossi.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 72
Total pull requests: 94
Average time to close issues: 10 months
Average time to close pull requests: 3 months
Total issue authors: 41
Total pull request authors: 25
Average comments per issue: 3.18
Average comments per pull request: 3.3
Merged pull requests: 79
Bot issues: 0
Bot pull requests: 14

Past Year

Issues: 5
Pull requests: 37
Average time to close issues: 3 days
Average time to close pull requests: 5 days
Issue authors: 3
Pull request authors: 6
Average comments per issue: 4.0
Average comments per pull request: 2.24
Merged pull requests: 34
Bot issues: 0
Bot pull requests: 13

View more stats

Top Authors

Issue Authors

pllim (13)
bsipocz (6)
astrofrog (5)
Gabriel-p (3)
waszil (3)
appukuttan-shailesh (2)
JWCook (2)
maxnoe (2)
seanjkanderson (2)
endremborza (1)
dstansby (1)
Elisa-Visentin (1)
barry-gallagher (1)
lovesegfault (1)
simaoafonso-pwt (1)

Pull Request Authors

bsipocz (24)
dependabot[bot] (17)
pllim (16)
astrofrog (11)
ConorMacBride (4)
lukelbd (4)
m-rossi (3)
saimn (3)
waszil (2)
adrn (2)
ayshih (2)
nstarman (2)
lpsinger (2)
kylefawcett (2)
WilliamJamieson (2)

Top Labels

Issue Labels

bug (22) question (8) upstream fix required (2) wontfix (2) enhancement (2) duplicate (1)

Pull Request Labels

no-changelog-entry-needed (26) enhancement (15) no-changelog-needed (14) bug (11) Build wheels (3) dependencies (2) upstream fix required (1)

Packages

Total packages: 2
Total downloads:
- pypi 157,947 last-month
Total docker downloads: 6,828

Total dependent packages: 279
(may contain duplicates)
Total dependent repositories: 459
(may contain duplicates)
Total versions: 29
Total maintainers: 4

pypi.org: sphinx-automodapi

Sphinx extension for auto-generating API documentation for entire modules

Homepage: https://github.com/astropy/sphinx-automodapi
Documentation: https://sphinx-automodapi.readthedocs.io/
License: BSD 3-Clause License
Latest release: 0.20.0
published 8 months ago

Versions: 21
Dependent Packages: 275
Dependent Repositories: 440
Downloads: 157,947 Last month
Docker Downloads: 6,828

Rankings

Dependent packages count: 0.1%

Dependent repos count: 0.7%

Downloads: 1.2%

Docker downloads count: 1.3%

Average: 3.0%

Forks count: 6.3%

Stargazers count: 8.6%

Maintainers (4)

robitaille Erik.Tollerud bsipocz saimon

Last synced: 6 months ago

conda-forge.org: sphinx-automodapi

This is a Sphinx extension to automatically generate API pages for whole modules.

Homepage: https://github.com/astropy/sphinx-automodapi
License: BSD-3-Clause
Latest release: 0.14.1
published about 4 years ago

Versions: 8
Dependent Packages: 4
Dependent Repositories: 19

Rankings

Dependent repos count: 8.1%

Dependent packages count: 12.5%

Average: 21.8%

Forks count: 27.5%

Stargazers count: 39.1%

Last synced: 6 months ago

Dependencies

.github/workflows/ci_workflows.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite
codecov/codecov-action v2 composite

.github/workflows/publish.yml actions

actions/checkout v2 composite
actions/setup-python v2 composite
pypa/gh-action-pypi-publish release/v1 composite

pyproject.toml pypi

setup.py pypi