使用狮身人面像Autodoc时模拟内部模块

Question

我的python包有一个名为 settings.py 的模块，它查找一个设置.ini文件，如果没有找到，则会引发异常。

我的软件包工作正常，但是当我尝试使用狮身人面像Autodoc时，它失败了，因为它找不到设置文件。

我有什么选择可以解决这个问题？我能想到的是

1. 将设置.ini文件放在狮身人面像目录之一中，以便可以读取。
2. 如果可能的话，以某种方式模拟内部设置模块。设置模块并不重要，所以我不在乎它是否没有文档

在尝试在需要外部文件的软件包上生成 Sphinx 文档时，是否有人遇到过类似的问题，如果是这样，您的解决方案是什么？

Answer 1

Pyramid 有一个命令行脚本 pserve，用于加载.ini设置文件。

为了记录这个脚本，我们使用自动程序，如下所示：

.. autoprogram:: pyramid.scripts.pserve:PServeCommand.parser
    :prog: pserve

在您的conf.py中：

extensions = [
...
    'sphinxcontrib.autoprogram',
...
]

它需要在脚本中使用 argparse。