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.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 648bc665a83c4e12f3591b61bd90cb3516e49d6da027cbf3fb73e6362df84b36 |
|
MD5 | 7e0b2a6757e58a6e230b5db470a4546f |
|
BLAKE2b-256 | 0d1abfd9d4b469da03238bc6825dd85e54c239ba1bd8168138d0e9ad148e9349 |