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 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 (v2)
To use the new pydata-sphinx-theme with sphinx_astropy.conf.v2, you have to install the optional [v2] dependencies:
pip install sphinx-astropy[v2]
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.
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.9.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9775ed03e979b57736ca82bcb0334e254914559ad7d91e29e7cbae8430f207c4 |
|
MD5 | 989d625a902b79c7350433ec2aa87079 |
|
BLAKE2b-256 | 6ead768cd92c31cba16aa1a93272717f0750cc786eb3331acdf100afdf70e869 |