用于文档样式的itcase sphinx主题。
itcase-sphinx-theme的Python项目详细描述
itcase sphinx主题
安装
$ pip install itcase_sphinx_theme -U
编辑斯芬克斯的conf.py
靠近顶部,添加以下内容
importitcase_sphinx_theme
激活主题
html_theme='itcase'html_theme_path=[itcase_sphinx_theme.get_html_themes_path()]
如果您想在底部看到主题的版本,只需添加扩展名:
extensions=['itcase_sphinx_theme']
主题选项
您可以在conf.py中设置主题选项。
html_theme_options={'travis_button':True,'github_button':True,'github_user':'ITCase','github_repo':'pyramid_sacrud',}
以下是具有默认值的选项列表:
- logo-在导航菜单顶部显示徽标。default: false
- logo_image-徽标的路径。default: ""
- logo_width-width在'px'或'%'中。default: ""
- logo_height-“px”或“%”中的高度。default: ""
- logo_image_desc-徽标图像后的说明。default: ""
- 索引菜单-在主页面上显示导航菜单。default: false
- 粘滞菜单-使导航元素在页面上始终可见。default: true
- github_按钮-在面包屑下显示git星徽。default: false
- github用户-default: ""
- github回购-default: ""
- travis_按钮-在面包屑下显示travis徽章。default: false
- travis_用户-default: ""
- travis回购-default: ""
- 主题选项
You can set theme options in ^{tt1}$. Here are list of options with default values:
- 商标default: False
- 徽标图像default: ""
- 徽标宽度default: ""
- 徽标高default: ""
- logo_image_descdefault: ""
- 索引菜单default: False
粘滞菜单-default: True
使导航元素在页面上始终可见。
github_按钮-default: False
在breadcrumbs下显示git star repository按钮。
github用户-default: ""
Github回购-^{TT4}$
- travis_button=default: False