Skip to main content

The sphinx theme for Astropy and affiliated packages.

Project description

This is the repository for the default Astopy project documentation theme(s). To use this theme, simply install this package then add the following line to your documentation’s conf.py file:

html_theme = 'bootstrap-astropy'

This requires Sphinx 1.6 or later to work properly. For older versions of Sphinx, you will need to do:

import astropy_sphinx_theme
html_theme_path = astropy_sphinx_theme.get_html_theme_path()
html_theme = 'bootstrap-astropy'

bootstrap-astropy is the only theme that is currently available, but the structure of the package allows more themes to be added in future if needed.

https://circleci.com/gh/astropy/astropy-sphinx-theme/tree/master.svg?style=svg

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

astropy-sphinx-theme-1.0.tar.gz (28.1 kB view hashes)

Uploaded Source

Built Distribution

astropy_sphinx_theme-1.0-py2.py3-none-any.whl (31.0 kB view hashes)

Uploaded Python 2 Python 3

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