sphinx-panels

一个针对HTML+CSS优化的文档组件的sphinx扩展。

• panels 指令创建网格布局的内容面板，利用Bootstrap 4的网格系统和卡片布局。

• link-button 指令创建可点击的按钮，链接到URL或引用，也可以用来使整个面板可点击。

• dropdown 指令创建可切换的内容。

• tabbed 指令创建标签内容。

• opticon 和 fa (fontawesome) 角色允许添加内联图标。

.. panels::

    Content of the top-left panel

    ---

    Content of the top-right panel

    ---

    Content of the bottom-left panel

    ---

    Content of the bottom-right panel

link-button 指令可用于创建按钮，这些按钮链接到 URL（默认）或引用。它们可以使用 Bootstrap 按钮类 进行样式化。

.. panels::

    .. link-button:: https://example.com
        :type: url
        :tooltip: hallo
        :classes: btn-success

    ---

    This entire panel is clickable.

    +++

    .. link-button:: panels/usage
        :type: ref
        :text: Go To Reference
        :classes: btn-outline-primary btn-block stretched-link

dropdown 指令将 Bootstrap 卡 与 HTML details 标签 结合起来，以创建可折叠的下拉面板。

.. dropdown:: Click on me to see my content!

    I'm the content which can be anything:

    .. link-button:: https://example.com
        :text: Like a Button
        :classes: btn-primary

开发

运行测试

pip install tox
tox -e py37-sphinx3

测试构建文档

tox -e docs-clean html
tox -e docs-rebuild html

文档的实时构建

tox -e docs-live html

您还可以通过设置 HTML_THEME 为 alabaster、sphinx_rtd_theme、pydata_sphinx_theme 或 sphinx_book_theme 中的任何一个来在不同的主题下构建文档。

export HTML_THEME=sphinx_book_theme
tox -e docs-live

代码风格和 SCSS -> CSS 更新

pip install pre-commit
pre-commit run --all