Skip to main content

Sphinx extensions and configuration specific to the Astropy project

Project description

Zenodo DOI 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:

from sphinx_astropy.conf import *

at the top of your 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:

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


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:

Project details

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.9.1.tar.gz (19.3 kB view hashes)

Uploaded source

Built Distribution

sphinx_astropy-1.9.1-py3-none-any.whl (23.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page