Data

Tools

Indexes

Applications

Experiments

Open Source Science

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

Sphinx functionality for Astropy

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

Science Score: 46.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
    Links to: zenodo.org
  • ✓
    Committers with academic emails
    2 of 19 committers (10.5%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.7%) to scientific vocabulary

Keywords from Contributors

astropy astronomy astrophysics astropy-affiliated closember sphinx ccd advanced-scientific-data-format asdf regionalization
Last synced: 7 months ago · JSON representation

Repository

Sphinx functionality for Astropy

Basic Info
  • Host: GitHub
  • Owner: astropy
  • License: bsd-3-clause
  • Language: Python
  • Default Branch: main
  • Homepage:
  • Size: 252 KB
Statistics
  • Stars: 6
  • Watchers: 10
  • Forks: 18
  • Open Issues: 12
  • Releases: 6
Created about 8 years ago · Last pushed 8 months ago
Metadata Files
Readme Changelog License

README.rst 

About
=====

.. image:: https://zenodo.org/badge/119399685.svg
   :target: https://zenodo.org/badge/latestdoi/119399685
   :alt: Zenodo DOI

.. image:: https://github.com/astropy/sphinx-astropy/actions/workflows/python-tests.yml/badge.svg
   :target: https://github.com/astropy/sphinx-astropy/actions/workflows/python-tests.yml
   :alt: CI Status

This package serves two purposes: it provides a default Sphinx configuration and set of extensions specific to the Astropy project, and it acts as a meta-package by installing all required Sphinx extensions for the core Astropy package and other packages.

Sphinx configuration
--------------------

The default Sphinx configuration can be imported by putting:

.. code-block:: python

    from sphinx_astropy.conf import *

at the top of your ``conf.py`` file. You can then override specific settings from this default configuration, such as adding extensions or intersphinx packages. To give a clearer error messages for users, you can instead write:

.. code-block:: python

    try:
        from sphinx_astropy.conf import *
    except ImportError:
        print('ERROR: the documentation requires the sphinx-astropy package to be installed')
        sys.exit(1)

Dependencies/extensions
-----------------------

Installing **sphinx-astropy** will automatically install (if not already present):

* `Sphinx `_

* `astropy-sphinx-theme `_ - the default 'bootstrap' theme use by Astropy and a number of affiliated packages. This goes with `sphinx_astropy.conf.v1`.

* `sphinx-automodapi `_ - an extension that makes it easy to automatically generate API documentation.

* `sphinx-gallery `_ - an extension to generate example galleries

* `numpydoc `_ - an extension to parse docstrings in NumpyDoc format

* `pillow `_ - a package to deal with
  images, used by some examples in the astropy core documentation.

* `pytest-doctestplus `_ - providing the 'doctestplus' extension to skip code snippets in narrative documentation.

pydata-sphinx-theme (confv2)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To use the new `pydata-sphinx-theme` with `sphinx_astropy.conf.v2`, you have to install
the optional `[confv2]` dependencies::

    pip install sphinx-astropy[confv2]

That would pull in the following as well:

* `pydata-sphinx-theme `_ - a clean, three-column,
  Bootstrap-based Sphinx theme by and for the `PyData community `_.

* `sphinx-copybutton `_ - a small Sphinx
  extension to add a "copy" button to code blocks.

Owner

  • Name: The Astropy Project
  • Login: astropy
  • Kind: organization

GitHub Events

Total
  • Create event: 7
  • Release event: 1
  • Issues event: 4
  • Watch event: 1
  • Delete event: 5
  • Issue comment event: 10
  • Push event: 9
  • Pull request review event: 10
  • Pull request event: 20
  • Fork event: 1
Last Year
  • Create event: 7
  • Release event: 1
  • Issues event: 4
  • Watch event: 1
  • Delete event: 5
  • Issue comment event: 10
  • Push event: 9
  • Pull request review event: 10
  • Pull request event: 20
  • Fork event: 1

Committers

Last synced: 9 months ago

All Time
  • Total Commits: 238
  • Total Committers: 19
  • Avg Commits per committer: 12.526
  • Development Distribution Score (DDS): 0.79
Past Year
  • Commits: 25
  • Committers: 3
  • Avg Commits per committer: 8.333
  • Development Distribution Score (DDS): 0.64
Top Committers
Name Email Commits
Thomas Robitaille t****e@g****m 50
P. L. Lim 2****m 41
Brigitta Sipőcz b****z@g****m 40
Michael Droettboom m****m@g****m 22
Simon Conseil c****t@s****g 20
Erik Tollerud e****d@g****m 19
dependabot[bot] 4****] 9
E. Madison Bray e****y@g****m 8
Nathaniel Starkman (@nstarman) n****n@p****m 7
Kyle Barbary k****y@g****m 7
Miguel de Val-Borro m****l@g****m 3
Larry Bradley l****y@g****m 3
Dan D'Avella d****a@g****m 3
ehogan e****n@g****u 1
Christoph Deil D****h@g****m 1
Eero Vaher e****r@a****e 1
Marten van Kerkwijk m****k@a****a 1
Michael Seifert m****4@y****e 1
Will Barnes w****s@g****m 1
Committer Domains (Top 20 + Academic)
yahoo.de: 1 astro.utoronto.ca: 1 astro.lu.se: 1 gemini.edu: 1 saimon.org: 1

Issues and Pull Requests

Last synced: 7 months ago

All Time
  • Total issues: 27
  • Total pull requests: 63
  • Average time to close issues: about 1 year
  • Average time to close pull requests: 15 days
  • Total issue authors: 12
  • Total pull request authors: 13
  • Average comments per issue: 3.11
  • Average comments per pull request: 2.13
  • Merged pull requests: 55
  • Bot issues: 0
  • Bot pull requests: 11
Past Year
  • Issues: 3
  • Pull requests: 20
  • Average time to close issues: about 2 hours
  • Average time to close pull requests: 1 day
  • Issue authors: 2
  • Pull request authors: 3
  • Average comments per issue: 2.67
  • Average comments per pull request: 0.5
  • Merged pull requests: 18
  • Bot issues: 0
  • Bot pull requests: 9
View more stats
Top Authors
Issue Authors
  • pllim (8)
  • bsipocz (5)
  • astrofrog (4)
  • mkelley (1)
  • taldcroft (1)
  • MSeifert04 (1)
  • weaverba137 (1)
  • delaneydunne (1)
  • saimn (1)
  • eteq (1)
  • larrybradley (1)
  • nstarman (1)
Pull Request Authors
  • pllim (17)
  • dependabot[bot] (16)
  • bsipocz (13)
  • astrofrog (8)
  • saimn (6)
  • larrybradley (3)
  • jonathansick (2)
  • nstarman (2)
  • eerovaher (1)
  • eteq (1)
  • migueldvb (1)
  • mhvk (1)
  • wtbarnes (1)
Top Labels
Issue Labels
bug (7) help wanted (3) wontfix (2) enhancement (2)
Pull Request Labels
dependencies (16) bug (6) Build wheels (5) github_actions (4) enhancement (3) wontfix (1)

Packages

  • Total packages: 2
  • Total downloads:
    • pypi 16,712 last-month
  • Total dependent packages: 109
    (may contain duplicates)
  • Total dependent repositories: 92
    (may contain duplicates)
  • Total versions: 21
  • Total maintainers: 4
pypi.org: sphinx-astropy

Sphinx extensions and configuration specific to the Astropy project

  • Versions: 13
  • Dependent Packages: 108
  • Dependent Repositories: 85
  • Downloads: 16,712 Last month
Rankings
Dependent packages count: 0.2%
Dependent repos count: 1.6%
Downloads: 3.0%
Average: 7.1%
Forks count: 9.1%
Stargazers count: 21.5%
Maintainers (4)
robitaille Erik.Tollerud bsipocz saimon
Last synced: 7 months ago
conda-forge.org: sphinx-astropy

This package serves two purposes: it provides a default Sphinx configuration and set of extensions specific to the Astropy project, and it acts as a meta-package by installing all required Sphinx extensions for the core Astropy package and other packages.

  • Versions: 8
  • Dependent Packages: 1
  • Dependent Repositories: 7
Rankings
Dependent repos count: 12.9%
Dependent packages count: 29.0%
Average: 35.7%
Forks count: 40.1%
Stargazers count: 60.7%
Last synced: 7 months ago

Dependencies

.github/workflows/publish.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
  • pypa/gh-action-pypi-publish release/v1 composite
.github/workflows/python-tests.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
pyproject.toml pypi
setup.py pypi