sphinx-design2

一个用于设计美观、响应视图大小的Web组件的Sphinx扩展。

sphinx-design的分支，用于本地开发。

在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)

主题支持

在多个主题中查看文档

• alabaster
• sphinx-book-theme
• pydata-sphinx-theme
• sphinx-rtd-theme
• furo

与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）

rtd PRs不工作