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):
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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for sphinx_astropy-1.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 68247af4a7e8f20211d3783691486b324f8b95f11945e5b61b98b81a521548ba |
|
MD5 | ceaf7d0a85255fe96601071e1a771dc7 |
|
BLAKE2b-256 | 0b717117d98a506e842547da66659a7679d710aeb9de6af0918218c8abdc9592 |