如何在目录中生成机器人框架文档(libdoc

Question

我在一个目录中有几个python库文件。所有这些文件一起用于测试自动化目的。有没有办法生成该目录中所有文件中关键字的文档(使用libdoc或任何其他工具)。这样，我们可以让用户知道自动化库中所有可用的关键字，而不需要知道存在哪些库文件。所以基本上我想为一个目录中的所有python文件生成一个文档。这有可能吗？有没有其他的替代方案来实现同样的目标？

Answer 1

一种替代方法是使用robotframework hub。hub是一个个人web应用程序，您可以指向某个文件夹，为该文件夹或该文件夹下的所有关键字提供文档。(注:我是这个包的作者)

您也可以使用robot framework docs manager。它在概念上与集线器大致相似，但功能更强大(也可以说更复杂)。

Answer 2

这段代码将递归地为资源(.robot)或库(.py)文件生成代码，并将这些文件放在一个与输入文件具有相同文件夹结构的单独文件夹中。

在for循环之前尝试不使用shutil.rmtree(...)，以防万一。

import os
import shutil

in_path = <full path to input files>
out_path = <full path to output files>

shutil.rmtree(out_path, ignore_errors=True)
for root, dirs, files in os.walk(in_path):
    for file in files:
        splitext = os.path.splitext(file)
        if splitext[1] == '.robot':
            rel_path = os.path.relpath(root, in_path)
            in_file = os.path.join(root, file)
            out_dir = os.path.normpath(os.path.join(out_path, rel_path))
            out_file = os.path.join(out_dir, splitext[0] + '.html')

            if not os.path.exists(out_dir):
                os.makedirs(out_dir)
            libdoc(in_file, out_file, docformat='ROBOT')