sphinxcontrib-htsql 0.1.5

概述

sphinxcontrib-htsql是嵌入HTSQL查询的扩展 在Sphinx文档中。

你可以在 http://htsql.org/doc/overview.html#htsql-in-a-nutshell。更多 示例，请参见源发行版中的demo目录。

本软件由kirill simonov（Prometheus Research, LLC）编写 并在BSD许可下发布。

用法

若要启用此扩展，请将以下行添加到conf.py：

extensions.append('sphinxcontrib.htsql')

您还需要指定htsql服务的地址：

htsql_root = 'http://demo.htsql.org'

现在可以使用^{tt4}将htsql查询添加到任何sphinx文档$ 指令：

.. htsql:: /school?campus='old'

此指令执行查询并插入复合块 由查询字符串和表格形式的查询输出组成。

如果查询跨越多行，则可以在指令中写入 正文：

.. htsql::

   /school.define(num_dept := count(department))
          {code, num_dept}?num_dept>3

如果要用另一个查询的输出显示一个查询，请使用 output选项。它有助于描述破坏性操作， 尚未实现功能或转义规则。你需要引用 空白和特殊字符手动：

.. htsql:: /school?campus='north'
   :output: /school?campus='south'

通常，htsql指令要求查询有效。使用 error选项，指示查询无效，并且您希望 显示错误消息：

.. htsql:: /school{code, title}
   :error:

通常，查询是通过指向htsql的链接呈现的 服务。使用no-link选项禁用此功能：

.. htsql:: /school?exists(department)
   :no-link:

使用no-output选项呈现查询，但不呈现输出：

.. htsql:: /school[ns]
   :no-output:

使用no-input选项呈现查询输出，但不呈现查询 本身：

.. htsql:: /school[ns]
   :no-input:

通常，查询输出呈现为表。使用选项raw到 使输出无格式：

.. htsql:: /school[ns]/:json
   :raw:

使用cut选项将查询输出截断为给定的数字 一排排的。此选项同时适用于表格和原始输出：

.. htsql:: /school
   :cut: 3

参考