使用 KarmaCSS 构建的 sphinx 主题
项目描述
# Karma Sphinx Theme
一个简单的响应式 sphinx 主题。这个主题处于早期开发阶段，因此只包含有限选项。
## 安装
```
pip install karma_sphinx_theme
```
## 配置
主题的全局选项定义在 `karma_sphinx_theme/theme.conf` 文件中，并且可以在项目的 `conf.py` 文件中通过 `html_theme_options` 定义。例如
html_theme_options = {
'navigation_depth': 2,
```
'includehidden': True,
'titles_only': False
}
}
```
## 选项
* `navigation_depth` Int. 指示树的最大深度，默认包含 2 级。
* `includehidden` Bool. 指定侧边栏是否包含带有 `:hidden:` 选项的 toctree。
* `titles_only` Bool. 如果为 True，则从侧边栏中删除页面内的标题。
一个简单的响应式 sphinx 主题。这个主题处于早期开发阶段，因此只包含有限选项。
## 安装
```
pip install karma_sphinx_theme
```
## 配置
主题的全局选项定义在 `karma_sphinx_theme/theme.conf` 文件中，并且可以在项目的 `conf.py` 文件中通过 `html_theme_options` 定义。例如
html_theme_options = {
'navigation_depth': 2,
```
'includehidden': True,
'titles_only': False
}
}
```
## 选项
* `navigation_depth` Int. 指示树的最大深度，默认包含 2 级。
* `includehidden` Bool. 指定侧边栏是否包含带有 `:hidden:` 选项的 toctree。
* `titles_only` Bool. 如果为 True，则从侧边栏中删除页面内的标题。
下载文件
下载适用于您的平台的文件。如果您不确定选择哪个，请了解更多关于 安装软件包 的信息。
源代码分发
karma_sphinx_theme-0.0.8.tar.gz (96.1 kB 查看哈希值)
关闭
karma_sphinx_theme-0.0.8.tar.gz 的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | 5a95f91818b458bd5bdf62690828361a369a222f0721cd0e1eb2ea29056e8c27 |
|
| MD5 | 877713fed74d1ba0d7ca3d791a2fc724 |
|
| BLAKE2b-256 | 533825be66e776ee0d088d19a0b3d1abc58020cf8cb88d921e8b72d1c25ae641 |