Skip to main content

狮身人面像“clearquest”扩展

项目描述

描述

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

依赖项

狮身人面像

http://sphinx.pocoo.org/

PyWin32

http://sourceforge.net/projects/pywin32/(easy_installpip install不会自动安装PyWin32,因为egg包在pypi上不可用)

安装和使用

您可以使用easy_installpip安装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

项目详情


下载文件

下载适用于您平台的文件。如果您不确定要选择哪个,请了解有关安装包的更多信息。

源分布

sphinxcontrib-clearquest-0.6.zip (14.4 kB 查看哈希)

已上传 source

内置分布

sphinxcontrib-clearquest-0.6.win32.exe (207.7 kB 查看哈希)

已上传 2 7