如何使用Sphinx生成机器人文件的文档？

Question

我有一个机器人文件（calc_check.robot），其中每个测试用例都有单独的文档说明。

*** Settings *** 
Documentation 
...         The test cases are designed to test the calculator .

Library       ../../Library/AddNumbers


*** Test Cases ***
Calc_check_test Testcase01_a
[Documentation]
...      Verify that two numbers are added or not
[Tags]      add    calculator
${addition}=     Add numbers    10    20 

Calc_check_test Testcase01_b
[Documentation]
...      Verify that two numbers are added or not with negative sign
[Tags]      add    calculator
${addition}=     Add numbers    10    -20 

当我尝试使用rst文件(call_check.rst)为机器人文件生成文档时，我得到了完整的测试案例和文档，但我只需要"[Documentation]"部分。

calc_check
======================================

.. robot-settings::
   :source:/Users/sphinx/calc_check.robot

.. robot-tests::
   :source:/Users/sphinx/calc_check.robot

我希望从两个测试用例中提取文档部分（即只提取[test Case]的文档部分），而不包括测试用例代码。

请告诉我如何仅生成其文档部分。

- SDET

---

你是否使用了sphinx扩展支持robot framework文件？你说你有一个名为calc_check.robot的robot文件，但是正在使用sphinx与call_check.rst。你是如何从.robot文件创建.rst文件的呢？ - Bryan Oakley

Answer 1

机器人提供名为libdoc的文档生成库：

https://robot-framework.readthedocs.io/en/2.9.2/_modules/robot/libdoc.html

问题在于它只为库和资源文件生成文档（那些没有 ***Testcase*** 部分的文件）。

如果您需要从测试套件中生成文档，我建议将 TestSuite 临时更改为资源文件（将其部分更改为 Keywords），然后运行 libdoc 命令。

python -m robot.libdoc <path to res/lib> <list/show>

- jozefow

---

我正在使用Sphinx的“make html”命令生成文档，请建议我在.rst文件中需要进行哪些更改，以便它只生成机器人的文档部分。 - SDET

请添加您认识的可以提供帮助的人。谢谢。 - SDET