用于设计美观、响应视图大小的Web组件的Sphinx扩展。
项目描述
sphinx-design
用于设计美观、响应视图大小的Web组件的Sphinx扩展。
受Bootstrap (v5)、Material Design和Material-UI设计框架的启发而创建。
用法
只需pip安装sphinx-design并将其扩展添加到您的conf.py文件中。
extensions = ["sphinx_design"]
支持的浏览器
- Chrome >= 60
- Firefox >= 60
- Firefox ESR
- iOS >= 12
- Safari >= 12
- Explorer >= 12
(镜像：https://github.com/twbs/bootstrap/blob/v5.0.2/.browserslistrc)
主题支持
在多个主题中查看文档
与sphinx-panels的比较
此包是sphinx-panels的迭代版本，旨在替代它。有关从sphinx-panels迁移的信息，请参阅迁移指南。
开发
建议使用tox来运行测试和文档构建。运行tox -va以查看所有可用的tox环境。
要运行代码检查、格式化和SASS编译，请使用pre-commit。运行pre-commit run --all css将运行SASS编译器，您需要安装node和npm，或者您可以直接运行npm run css。
待办事项
- 注意设计目标；要灵活，但限制指令嵌套的数量。这包括
- 卡片头/尾语法？（不希望为这些内容使用单独的指令，因此使用
^^^/+++语法） - 自动换行
grid-item和tab-item，如果它们不在grid或tab-set内部的话？
- 卡片头/尾语法？（不希望为这些内容使用单独的指令，因此使用
网格项不能包含标题；这是否与docutils结构有关？
指令/角色的命名：标准前缀？
为什么卡片使用"word-wrap: break-word;"来设置？
处理LaTeX
在编译SASS时使用autoprefixer（请参阅https://bootstrap.ac.cn/docs/5.0/getting-started/browsers-devices/#supported-browsers）
水平卡片（卡片内的网格行，图片在左侧）
卡片的副标题（请参阅https://material.io/components/cards#anatomy）
关闭
sphinx_design-0.6.1.tar.gz的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | b44eea3719386d04d765c1a8257caca2b3e6f8421d7b3a5e742c0fd45f84e632 |
|
| MD5 | a9de747353ce75271639efb2fad2ac5c |
|
| BLAKE2b-256 | 2b69b34e0cb5336f09c6866d53b4a19d76c227cdec1bbc7ac4de63ca7d58c9c7 |
关闭
sphinx_design-0.6.1-py3-none-any.whl的哈希值
| 算法 | 哈希摘要 | |
|---|---|---|
| SHA256 | b11f37db1a802a183d61b159d9a202314d4d2fe29c163437001324fe2f19549c |
|
| MD5 | cd12f4ead9abe92dcdc20aa122720cae |
|
| BLAKE2b-256 | c64365c0acbd8cc6f50195a3a1fc195c404988b15c67090e73c7a41a9f57d6bd |