使用Sphinx Autodoc时模拟内部模块

Question

我的python程序包有一个名为settings.py的模块，该模块会查找settings.ini文件，如果找不到该文件，则会引发Exception。

我的程序包工作正常，但是当我尝试使用Sphinx Autodoc时，它失败了，因为它找不到设置文件。

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

1. 将settings.ini文件放在Sphinx目录之一中，以便可以读取。
2. 如果可能，以某种方式模拟内部设置模块。 设置模块不重要，因此我不介意是否有任何文件可提供给suer

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

Answer 1

金字塔有一个命令行脚本pserve ，可加载.ini设置文件。

为了记录此脚本，我们使用自动编程 ，如下所示：

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

并在您的conf.py ：

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

它要求在脚本中使用argparse 。