Patroni项目在Ubuntu 20.04环境下文档构建问题的分析与解决

在Patroni 3.3.0到3.3.2版本升级过程中，开发团队发现了一个在Ubuntu 20.04（Focal Fossa）系统上构建文档时出现的兼容性问题。这个问题导致使用Sphinx构建文档时出现属性错误，最终使得文档构建过程失败。

问题现象

当在Ubuntu 20.04环境下尝试构建Patroni文档时，系统会抛出以下错误信息：

AttributeError: 'StandaloneHTMLBuilder' object has no attribute 'found_docs'

这个错误发生在Sphinx尝试更新构建环境时，具体是在处理conf.py配置文件中的env_get_outdated函数时触发的。错误表明StandaloneHTMLBuilder对象缺少了预期的found_docs属性。

根本原因分析

经过深入调查，发现这个问题的根源在于Ubuntu 20.04默认提供的Sphinx版本（1.8.5）过于陈旧。这个版本发布于2019年3月，与Patroni项目文档构建系统中使用的新特性不兼容。

具体来说，Patroni的conf.py文件中包含了一段用于过滤不需要构建的文档的代码。这段代码假设Sphinx环境对象具有found_docs属性，但在旧版本的Sphinx中，这个属性并不存在或者以不同的方式实现。

解决方案

针对这个问题，开发团队提出了两种解决方案：

1. 兼容性修复：修改conf.py文件，使其能够兼容旧版Sphinx。具体做法是在访问环境属性前先进行检查：

if hasattr(env, 'found_doc'):
    for doc in env.found_docs:
        if _to_be_removed(doc):
            to_remove.add(doc)

同样，对project属性也进行类似的检查：

if hasattr(env, 'project'):
    env.project.docnames.difference_update(to_remove)

2. 升级构建环境：建议将构建环境升级到使用更新版本的Sphinx。Ubuntu 20.04虽然是一个长期支持版本，但其软件仓库中的某些工具版本确实较为陈旧，对于现代开源项目的构建可能会遇到类似兼容性问题。

技术建议

对于需要在Ubuntu 20.04环境下构建Patroni文档的用户，可以考虑以下建议：

1. 使用Python虚拟环境安装较新版本的Sphinx工具
2. 考虑使用容器技术（如Docker）来创建具有更新构建工具的隔离环境
3. 如果项目允许，可以考虑升级操作系统到较新的LTS版本

这个问题也提醒我们，在开发跨平台应用时，需要特别注意不同Linux发行版之间的工具链差异，特别是那些长期支持版本中可能存在的较旧软件版本。

总结

Patroni项目在Ubuntu 20.04环境下遇到的文档构建问题，本质上是新代码与旧工具链之间的兼容性问题。通过添加适当的属性检查，可以确保代码在不同版本的Sphinx上都能正常工作。同时，这也凸显了在持续集成环境中管理构建工具版本的重要性。