Sphinx集成sphinxcontrib_robotframework无法生成RF关键字文档问题

核心问题是3处配置缺失/错误，和插件版本无关，按以下步骤调整即可正常生成RobotFramework关键字文档：

1. 补全conf.py缺失的关键配置 #

当前仅开启了插件开关，没有告知插件RF资源文件的存放路径、需要加载的自定义关键字库，也没有开启关键字自动生成开关，插件默认不会主动扫描全目录文件。
在原有conf.py配置基础上补充/修改以下内容：

import os
import sys
sys.path.insert(0, os.path.abspath('../..'))

# -- 其余原有项目信息、通用配置保持不变 --

# sphinxcontrib_robotframework 配置修正
sphinxcontrib_robotframework_enabled = True
sphinxcontrib_robotframework_quiet = False # 调试阶段先关闭静默，可看到插件扫描RF文件的日志，功能正常后再改回True
sphinxcontrib_robotframework_source = os.path.abspath('../../') # 替换为你实际存放.robot/.resource资源文件的根目录
sphinxcontrib_robotframework_generate_keywords = True # 开启关键字文档自动生成开关
sphinxcontrib_robotframework_libraries = ['example_rf_docu'] # 声明写在Python代码里的自定义关键字库
sphinxcontrib_robotframework_variables = {
    "VARIABLE": "value"
}
suppress_warnings = ['app.add_directive'] # 屏蔽code指令重名的无关警告

2. 修正interface.rst的指令用法 #

空的.. code:: robotframework块仅用于渲染RF代码示例，不会触发关键字文档生成逻辑，需要替换为插件提供的专属文档指令。修正后的interface.rst内容如下：

example RF documentation
============================
Keywords
********
.. automodule:: example_rf_docu
   :members:
   :inherited-members:
   :undoc-members:

.. robotframework::
   :source: ../../
   :keywords:
   :resources:

3. 清除缓存强制全量构建 #

之前的构建日志显示loading pickled environment... done、0 added, 0 changed, 0 removed，说明Sphinx复用了旧缓存，修改配置后不会触发增量更新。执行以下命令清除旧产物后全量构建：

# 删除旧的构建产物
rm -rf /home/ute/repo/example_rf_docu/doc_files/*
# 加-E参数强制忽略缓存全量构建
sphinx-build -E -b html /home/ute/repo/example_rf_docu/docs/source/ /home/ute/repo/example_rf_docu/doc_files/

验证标准 #

构建时日志会输出插件扫描RF资源文件、解析关键字的相关信息，构建完成后interfaces页面会正常展示所有Python自定义关键字、RF资源文件内定义的关键字的参数、说明、使用示例信息。

内容的提问来源于stack exchange，提问作者7ek