Skip to main content

The sphinx theme for Astropy and affiliated packages.

Project description

This is the repository for the default Astropy 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.

Several options for the theme can be set in the conf.py file:

html_theme_options = {
    'logotext1': 'packagename',  # white,  semi-bold
    'logotext2': '',  # orange, light
    'logotext3': ':docs',   # white,  light
    'astropy_project_menubar': True
    }

The logotext? options can be used to customize the top left logo, while the astropy_project_menubar option can be set to True for packages that are managed by the project itself (this will add links to find out more about the Astropy project, about the team, and so on).

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.1.tar.gz (29.2 kB view hashes)

Uploaded source

Built Distribution

astropy_sphinx_theme-1.1-py2.py3-none-any.whl (31.4 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page