基于 Vuepress 的 Sphinx-doc 主题
项目描述
sphinx_press_theme
Python 的 Sphinx 文档生成器的现代化响应式主题。
在Press主题的官方网站上查看其实际效果网站
本主题基于VuePress构建。它使用了Vue.js & Stylus，并由vite管理。
Press主题仍处于BETA测试阶段。欢迎贡献力量。
安装
首先安装主题
$ pip install sphinx_press_theme
Sphinx版本兼容性
| Sphinx | Press主题 |
|---|---|
| 7.X | 最新版 |
| 4.X | 0.8.0 |
| 3.X | 0.6.1 |
| 2.X | 0.5.1 |
使用方法
在Sphinx项目的conf.py文件中：将主题名称设置为press。
html_theme = "press"
请参阅配置详情。
开发
首先构建网页资源
cd ui
npm install
npm run build
Sphinx主题对构建的资产有软链接... 使用pip install -e .在本地安装主题。
docs文件夹包含主题自身的文档。
cd docs
make clean html
发布
在
setup.pysphinx_press_theme/__init__.pysphinx_press_theme/theme.confdocs/source/conf.pyui/package.json
网站
更新网站
cd ../press_site
rsync -rvi ../sphinx_press_theme/docs/build/html/ .
git add --all
下载文件
下载适合您平台的文件。如果您不确定要选择哪个，请了解有关安装包的更多信息。
源分发
sphinx_press_theme-0.9.1.tar.gz (254.7 kB 查看哈希值)
