构建文档

(函数来自 pyomo.common.flags)

pyomo.common.flags.building_documentation(state=NOTSET)[source]

如果正在构建Sphinx文档,则为True

我们通过检查是否导入了sphinxSphinx模块来检测是否正在构建文档。

Parameters:

state (boolNone) – 如果提供,设置构建环境标志的当前状态 (设置为 None 会恢复到正常的 sys.modules 查询)

Return type:

bool