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.

Files for astropy-sphinx-theme, version 1.0
Filename, size File type Python version Upload date Hashes
Filename, size astropy_sphinx_theme-1.0-py2.py3-none-any.whl (31.0 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size astropy-sphinx-theme-1.0.tar.gz (28.1 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page