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.

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.5.tar.gz (18.0 kB view details)

Uploaded Source

Built Distribution

sphinx_astropy-1.5-py3-none-any.whl (18.2 kB view details)

Uploaded Python 3

File details

Details for the file sphinx-astropy-1.5.tar.gz.

File metadata

  • Download URL: sphinx-astropy-1.5.tar.gz
  • Upload date:
  • Size: 18.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for sphinx-astropy-1.5.tar.gz
Algorithm Hash digest
SHA256 58aed38e4311fb0842c7b0d0df132c5787d089124f31e64211e18994cab0becc
MD5 9e11a1dad7d96cd93390b635309adaa6
BLAKE2b-256 2c06aa52f006e46900f3a33adf01f3f9c18ba1fa905c093b007c7ed186f4241c

See more details on using hashes here.

Provenance

File details

Details for the file sphinx_astropy-1.5-py3-none-any.whl.

File metadata

  • Download URL: sphinx_astropy-1.5-py3-none-any.whl
  • Upload date:
  • Size: 18.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.6.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for sphinx_astropy-1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 68247af4a7e8f20211d3783691486b324f8b95f11945e5b61b98b81a521548ba
MD5 ceaf7d0a85255fe96601071e1a771dc7
BLAKE2b-256 0b717117d98a506e842547da66659a7679d710aeb9de6af0918218c8abdc9592

See more details on using hashes here.

Provenance

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