sphinxcontrib-clearquest 0.6

描述

一个Sphinx扩展，它添加了一个 clearquest 指令，用于将 ClearQuest 请求转换为 reStructuredText 表格。

依赖关系

Sphinx

https://sphinx-doc.cn/

PyWin32

http://sourceforge.net/projects/pywin32/ (PyWin32 将不会由 easy_install 或 pip install 自动安装，因为 pypi 上不可用 egg 包)

安装与使用

您可以使用 easy_install 或 pip 安装 sphinxcontrib.clearquest 包。

$ easy_install sphinxcontrib-clearquest

或者使用此页上提供的Windows安装程序。

将 'sphinxcontrib.clearquest' 添加到扩展参数，然后运行Sphinx。

指令语法

指令的语法如下

.. clearquest:: <full name/of the clearquest query> (mandatory)
   :params: <parameters to pass to the query> (optional)
   :username: <your username> (optional)
   :password: <your password> (optional)
   :db_name: <the name of the db> (optional)
   :db_set: <the name of the db set> (optional)

传递给查询的参数必须遵循以下语法

<param1_name>=<param1_value>,<param2_name>=<param2_value>, ...

您可以按任何顺序提供它们，只要您不要忘记其中一个。如果这样做，查询调用将失败。

连接凭据可以是指令选项，也可以在 ~/.sphinxcontrib 文件中的 clearquest 部分，该文件是一个标准的 .ini 配置文件。

以下是 ~/.sphinxcontrib 文件的示例

[clearquest]
username = john
password = doe
db_name = prod
db_set = cqsrv