python-sphinx 记录没有 py 扩展名的脚本

Question

抱歉 - 这是一个完整的问题：

我有几个没有 .py 扩展名的 python 脚本。

我如何说服 Sphinx 它应该记录该脚本？错误示例：

/home/XXX/YYYYY/development/dst/build/index.rst:25：（警告/2）autodoc无法导入/查找模块“site_scons.random”，它报告错误：“没有名为随机的模块”，请检查你的拼写和 sys.path

Answer 1

为了使您的脚本成为模块，它需要包含后缀.py。来自Python文档：

模块是包含 Python 定义和语句的文件。文件名是模块名加上后缀.py。

如果不给它后缀，Sphinx 将无法导入它以使用automodule.

http://www.sphinx-doc.org/en/stable/ext/autodoc.html 上的文档说“如果您记录脚本（而不是库模块），请确保它们的主例程受到 if __name__ = 的保护='__main__'条件。” 这让我希望有一种方法来记录脚本。 (2认同)