kirlent-sphinx 0.3.0

功能

Kirlent_Sphinx提供以下组件：

• 从Cloud Sphinx Theme派生的扩展table指令 项目。
• 使用RevealJS的slide指令和相应的html主题 或者ImpressJS。

开始

您可以使用pip:

pip install kirlent_sphinx

要在项目中启用它，请在conf.py中进行以下更改：

• 将kirlent_sphinx添加到扩展名：

  extensions = ["kirlent_sphinx"]
  

• 使用下面的一行将主题设置为使用revealjs或impressjs：

  html_theme = "kirlent_revealjs"
  html_theme = "kirlent_impressjs"
  

• 禁用索引生成：

  html_use_index = False
  

用法

对于扩展的table指令，请参阅文档 在Cloud Sphinx Theme项目的table_styling扩展中。

slide指令可以支持大多数data-属性 如RevealJS和ImpressJS的文档所述 项目。

主题包括用于样式设置的Tailwind实用程序类：

.. slide:: Slide title

   .. container:: columns

      .. container:: column w-1/3 bg-blue-lighter

         - item 1a
         - item 1b

      .. container:: column bg-red-lighter

         - item 2

   .. speaker-notes::

      some extra explanation

许可证

版权所有（C）2019 H.Turgut Uyar<；uyar@tekir.org>；

Kirlent_Sphinx是根据BSD许可证发布的。阅读包含的 LICENSE.txt文件了解详细信息。

kirlent_sphinx包含从Cloud Sphinx Theme项目派生的代码 根据BSD许可证发布。阅读包含的 LICENSE_cloud_spheme.txt文件了解详细信息。

kirlent_sphinx包含从sphinxjp.themes.revealjs派生的代码 在麻省理工学院许可下发布的项目。阅读包含的 LICENSE_sphinxjp.themes.revealjs.txt文件了解详细信息。

kirlent_sphinx包含来自RevealJS项目的代码 在麻省理工学院的许可下发布。阅读包含的LICENSE_revealjs.txt 文件以获取详细信息。

kirlent_sphinx包含来自ImpressJS项目的代码 在麻省理工学院的许可下发布。阅读包含的LICENSE_impressjs.txt 文件以获取详细信息。

kirlent_sphinx包含来自Tailwind项目的代码 在麻省理工学院的许可下发布。阅读包含的LICENSE_tailwind.txt 文件以获取详细信息。