Question

我的用于机器人框架的示例Python模块如下所示。

ROBOT_LIBRARY_DOC_FORMAT = 'reST'

def foo (a, b):
    """Produces bar.

    :param ``a``: this is a.
    :param ``b``: this is b.
    """

但是，然后使用rfhub Web应用程序在浏览器中查看时，参数a和b粉碎到了一行，看起来好像是Wiki风格的。 rfhub支持reST吗？请参见下面的屏幕截图。

user@ubuntu-01:~$ python -m rfhub ./test-project/testcases
tornado web server running on http://127.0.0.1:7070

rfhub_example_helloworld

Answer 1

我现在的怀疑是robotframework hub根本不支持它。

要仔细检查，我这样做：

user @ ubuntu-01：〜$ python -m robot.libdoc ./test-project/testcases/HelloWorld.py testdoc.html

HelloWorld.py所在的位置：

ROBOT_LIBRARY_DOC_FORMAT = 'reST' 

def foo(a, b): 
    """Produces bar. 

    :param ``a``: this is a. 
    :param ``b``: this is b. 
    """ 
    return "bar" 

def foo2(a, b): 
    """Also produces bar. 

    :a: this is a. 
    :b: this is b. 
    """ 
    return "bar"

上面在我的浏览器中产生以下输出：

libdoc_output_restructuredtext

如我所料，对于reStructuredText，这显示了将字段分为几行。如果我注释掉ROBOT_LIBRARY_DOC_FORMAT行，它将不再起作用。我将向原始问题添加类似的屏幕截图，以在robotframework hub中显示该问题。

Python函数中的reStructuredText未显示在Robot Framework集线器中

1 个答案: