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/main.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-2.0.tar.gz (33.7 kB view details)

Uploaded Source

Built Distribution

astropy_sphinx_theme-2.0-py3-none-any.whl (32.1 kB view details)

Uploaded Python 3

File details

Details for the file astropy_sphinx_theme-2.0.tar.gz.

File metadata

  • Download URL: astropy_sphinx_theme-2.0.tar.gz
  • Upload date:
  • Size: 33.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for astropy_sphinx_theme-2.0.tar.gz
Algorithm Hash digest
SHA256 9c4d9033cc7df306e2134eceec7597d2950d424e4fe6201f2fbf788e3ceb8b97
MD5 12f3d5d3abe5f36203d6688f4b29cb31
BLAKE2b-256 09360773a435911f21b45adfe356876691fc0e67f10c494e5e0142c55c6fb7e2

See more details on using hashes here.

File details

Details for the file astropy_sphinx_theme-2.0-py3-none-any.whl.

File metadata

File hashes

Hashes for astropy_sphinx_theme-2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d7cd4fe97f069522015d9026ef53ba3d9eb88f9ce972ff90c80c57fff6228908
MD5 97de9c2230fa5dec6916426df72ba1eb
BLAKE2b-256 72838fe51c1fc6442c719d9b635d07413edb658c9ac4d6e5d00becc4fbbf3d56

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page