latex - 如何使用 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 

当我尝试使用第一个文件 (call_check.rst) 为该机器人文件生成文档时，我得到了完整的测试用例以及文档，但我只需要“[文档]”部分。

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

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

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

我想要两个测试用例的文档(即测试用例的 [Documentation] 部分)，不包括测试用例代码。

请告诉我如何只生成它的文档部分。

Answer 1

Robot 提供了名为libdoc 的文档生成库:

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

问题是它只为库和资源文件生成(那些没有 ***Testcase*** 部分的)。

如果您需要从测试套件生成文档，我会建议将 TestSuite 临时更改为资源文件(将部分更改为关键字)并为此类文件运行 libdoc:

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