Skip to main content

Sphinx extensions and configuration specific to the Astropy project

Project description

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 affilited packages.
  • 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.

CircleCI Status

Project details


Download files

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

Files for sphinx-astropy, version 1.2
Filename, size File type Python version Upload date Hashes
Filename, size sphinx_astropy-1.2-py2.py3-none-any.whl (17.3 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size sphinx-astropy-1.2.tar.gz (15.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page