跳转到主要内容

Astropy及其相关包的sphinx主题。

项目描述

这是默认Astropy项目文档主题的存储库。要使用此主题,请安装此包,然后将以下行添加到您的文档的 conf.py 文件中

html_theme = 'bootstrap-astropy'

这需要Sphinx 1.6或更高版本才能正确工作。对于Sphinx的较旧版本,您需要执行

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

bootstrap-astropy 是目前唯一可用的主题,但该包的结构允许在需要时添加更多主题。

主题的几个选项可以在 conf.py 文件中设置

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

logotext? 选项可用于自定义左上角的标志,而 astropy_project_menubar 选项可以设置为 True 以便为项目自身管理的包设置(这将添加有关 Astropy 项目、团队等信息链接)。

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

由以下组织支持