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.

Sphinx configuration

The default Sphinx configuration can be imported by putting:

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:

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.

astropy-unified theme (confv3)

To use the new astropy-unified theme, which is a derivative of pydata-sphinx-theme and sunpy-sphinx-theme with sphinx_astropy.conf.v3, you have to install the optional [confv3] dependencies:

pip install sphinx-astropy[confv3]

This would pull in the following as well:

astropy-sphinx-theme >=3.0
All confv3 dependencies.

Intended Audience
- Developers
Operating System
- OS Independent
Programming Language
- Python
- Python :: 3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_astropy-1.11.tar.gz (21.9 kB view details)

Uploaded May 11, 2026 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

sphinx_astropy-1.11-py3-none-any.whl (25.3 kB view details)

Uploaded May 11, 2026 Python 3

File details

Details for the file sphinx_astropy-1.11.tar.gz.

File metadata

Download URL: sphinx_astropy-1.11.tar.gz
Upload date: May 11, 2026
Size: 21.9 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for sphinx_astropy-1.11.tar.gz
Algorithm	Hash digest
SHA256	`4a01cbcc2f407b134c69608edbd848ab391cb06fb4f5bea8aa894052f95e438f`
MD5	`2c50b16cbf363d2c98e23d628169fdc3`
BLAKE2b-256	`74040798aaa130ed8627b5160e499e9e5495d82e6e900467ee889c4d6dc791ef`

See more details on using hashes here.

Provenance

The following attestation bundles were made for sphinx_astropy-1.11.tar.gz:

Publisher: publish.yml on astropy/sphinx-astropy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: sphinx_astropy-1.11.tar.gz
- Subject digest: 4a01cbcc2f407b134c69608edbd848ab391cb06fb4f5bea8aa894052f95e438f
- Sigstore transparency entry: 1508299409
- Sigstore integration time: May 11, 2026
Source repository:
- Permalink: astropy/sphinx-astropy@66e6ba9b13c0869b2259a0726eaedf264def3553
- Branch / Tag: refs/tags/v1.11
- Owner: https://github.com/astropy
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@66e6ba9b13c0869b2259a0726eaedf264def3553
- Trigger Event: push