9. Sphinx Design扩展模块介绍#
用于设计漂亮的、屏幕大小的响应式 Web 组件的 Sphinx 扩展。
Sphinx的设计初始目的是用于技术文档的撰写与组织,侧重于内容。 对于样式则主要通过主题来实现,这就限制了其在表现方式上的多样性。 尤其要考虑到面向不同输出格式的一致性,会尽量减少使用个性化的样式表现。
Sphinx Design 在一定程度上是要突破这个限制而设计的。 其通过扩展在Sphinx中加入了大量的HTML控件来丰富结果的表达。
备注
之所以对这个扩展进行介绍,是因为其对 Sphinx 样式方面有较大提升。而其是作为扩展模块,而非主题或者样式。
适用于多种主题的 Sphinx Design :class: note 该插件使用多个主题, 分别有 alabaster、sphinx-book-theme、pydata-sphinx-theme、sphinx-rtd-theme、furo 。 同时,Sphinx Design在不同主题下的语法可能不一样, 所以需要读者根据实际使用的主题来阅读 Sphinx Design 语法。 本篇章记录的 Sphinx Design 是适用于 sphinx-book-theme 的语法。
[点击前往官方文档查看](https://sphinx-design.readthedocs.io/en/sbt-theme/) 其他主题下的 Sphinx Design 的使用。