robotframework-libtoc 1.4.2

Robot Framework LibTOC

它能做什么

此工具使用Robot Framework Libdoc生成整个文件夹（或多个文件夹）的文档，并为这些资源/库创建一个目录（目录）文件

为什么使用它

Robot Framework Libdoc工具通常为单个关键字库或资源文件生成一个HTML文件。如果您有几个关键字库或资源，您将得到几个单独的HTML文件。

此工具将单独的关键字文档文件收集在一个地方，并为这些文件创建一个目录（目录）页面，包含指向这些文件的链接。
结果是包含几个静态HTML页面的文件夹，可以放置在内部网络中的某个位置或作为CI工件上传 - 这样每个人都可以轻松访问关键字文档。

以下是示例截图

它是如何工作的

• 该工具遍历指定的包含RF资源及其直接子文件夹的文件夹

• 它寻找名为 .libtoc 的 配置文件，其中包含您想要创建文档的项目

  1. 资源/lib文件的路径，使用glob格式
  2. RF库，使用提供的完全限定名在PYTHONPATH中安装或可用

     库导入参数（如果需要），如libdoc用户指南中所述。不支持其他libdoc CLI选项（例如输出文件的版本或名称）

  3. Python包内部资源/lib文件的路径，使用glob格式，从PYTHONPATH加载

     有关如何在Python包中捆绑RF资源，请参阅RF用户指南

• 然后使用libdoc生成文档 - 包括从glob模式解析的文件路径以及安装的库。创建的HTML文件放置在libtoc输出目录中 - 保持资源的原始子目录结构

• 最后，它生成一个包含指向所有生成的HTML文件的链接的目录（内容表）HTML页面。目录中的导航树结构与文件夹树结构重复

.libtoc配置文件示例

[paths]
# Use glob patterns
some-resources/**/*.robot
some-resources/**/*.resource
some-resources/**/*.py

[libs]
# Use RF library names with params - like for libdoc
SeleniumLibrary
Remote::http://10.0.0.42:8270
# Import a library from PYTHONPATH using fully qualified name
some-libs.mylib.mypy
# You can use environment variables in lib params
SomeLib::$some_env_var/somepath

[packages]
# Use package name in python path and glob patterns separated by :
some-package:resources/**/*.resource
some-package:libs/**/*.py

配置文件必须包含以下部分之一 - [paths]，[libs]，[packages]

如何安装

系统要求

• Python >=3.7
• Robot Framework

使用pip安装

pip install robotframework-libtoc

如何使用

• 在资源文件夹的根目录以及/或在需要创建文档的直接子文件夹中创建.libtoc配置文件。

• 运行libtoc。最后一个resources_dirs参数是必需的，它接受任意数量的路径。其他参数是可选的

  • -d, --output_dir
  • --config_file
  • --toc_file
  • --toc_template
  • --homepage_template
  • -P, --pythonpath

  示例

  libtoc example_resources
  libtoc 'example_resources/SUT X' 'example_resources/SUT Y'
  libtoc --output_dir docs example_resources
  libtoc --output_dir docs --toc_file MY_SPECIAL_NAME_FOR_DOCS.html example_resources
  libtoc --toc_template MY_CUSTOM_TOC.html --homepage_template MY_CUSTOM_HOMEPAGE.html example_resources
  

• 打开创建的文件，例如docs/keyword_docs.html

如何更改目录和主页HTML模板

默认的HTML模板文件位于Python安装目录中（通常是类似<python_dir>/lib/site-packages/robotframework_libtoc的路径），如果需要可以更改。
还可以使用--toc_template和--homepage_template选项提供自定义的HTML模板文件。

如何设置Python路径

有两种方法可以扩展搜索库的路径列表

1. 使用--pythonpath选项
2. 设置环境变量PYTHONPATH

更多信息请参阅Robot Framework用户指南。