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).
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
File details
Details for the file astropy-sphinx-theme-1.1.tar.gz
.
File metadata
- Download URL: astropy-sphinx-theme-1.1.tar.gz
- Upload date:
- Size: 29.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ee1dafa0cf4d109455f7a0d19da4cdd608ad24d380ed2eb8090bb945a3d286f9 |
|
MD5 | a7c6938b2e4cf1e2ea991acf324723f1 |
|
BLAKE2b-256 | 2373fc06598c336afa6626b4a50e2706bc235407bf975b5db9757d3a5e813e58 |
Provenance
File details
Details for the file astropy_sphinx_theme-1.1-py2.py3-none-any.whl
.
File metadata
- Download URL: astropy_sphinx_theme-1.1-py2.py3-none-any.whl
- Upload date:
- Size: 31.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.1
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 089a2007b8645137460eb70bdbbc4dbc5c15f0873991d5b526da013cfac008c4 |
|
MD5 | 94d4a3c2a205fd3d878ac523697b430b |
|
BLAKE2b-256 | 412cb59c6de34a802b4b0485cf0a8c5c9b3025651f79f6f468079d9c6dad2111 |