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
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.0-py2.py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f56ed7117028a5e9f23597bcb1be3a51fd137795a3d79dbc0a19415979b0a7a8 |
|
| MD5 | a5540d72c16e3e800dc44d2ec3d0a234 |
|
| BLAKE2b-256 | 9e829759758a1276f0d52cc0518e8db5f5ca1029ea0d5579d60fca52fb8f3a4a |
