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):
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.
4 maintainers
Release files for sphinx-astropy 1.11
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| sphinx_astropy-1.11.tar.gz | 21.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| sphinx_astropy-1.11-py3-none-any.whl | Python 3 | none | any | Details |
Total release size:47.1 kB
Release files / sphinx_astropy-1.11.tar.gz
| Download URL | sphinx_astropy-1.11.tar.gz |
|---|---|
| Size | 21.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4a01cbcc2f407b134c69608edbd848ab391cb06fb4f5bea8aa894052f95e438f
|
|
BLAKE2b-256 checksum How to use checksums |
74040798aaa130ed8627b5160e499e9e5495d82e6e900467ee889c4d6dc791ef
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 11, 2026.
Transparency logRelease files / sphinx_astropy-1.11-py3-none-any.whl
| Download URL | sphinx_astropy-1.11-py3-none-any.whl |
|---|---|
| Size | 25.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
6ec073750fd03166f4667c4a64240e4135cdf1f596047cd8698f80237521043a
|
|
BLAKE2b-256 checksum How to use checksums |
59b1fc953bb6b25f8a27ff80d3feaf93cb16c40224952804b98a1380283a6745
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.13
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on May 11, 2026.
Transparency log
