文档脚本不属于 sphinx 中的模块

Question

我查找了几个包（sphinx-gallery、autoprogram、...），但没有找到关于如何轻松使用 python 脚本中的文档字符串进行文档的任何内容。所以我想以某种方式对特定文件执行autodoc。

有人知道从 python 脚本中自动生成 sphinx 文档的可能性吗？

就像我在脚本的开头有一个文档字符串，可能还有一些带有文档字符串的函数，只是想自动生​​成一些文档，就像我可以使用 .. automodule::directive 一样，但不幸的是，这不适用于相对路径/ 脚本。

编辑：

我想创建一些文档字符串的脚本不是 cli 脚本，它只是一些通常被 cron 作业调用的 python 脚本。所以不幸的是，据我所知，自动编程在这里无济于事。

编辑2：

好的，所以在重新阅读文档并尝试之后，我对此有了更清晰的了解。我想要做的是自动获取 python 文件的文档字符串并将其放入文档而不执行整个文件（因为某些原因我不能或不想将所有内容隐藏在主程序）。我让 autodoc 记录一个特定的文件（有一些错误配置，为什么这不起作用），但就像它的文档中所述，它执行该文件。这是我真正的问题。如果有人有解决方案来实现这一点，我会很高兴，但如果不付出很大的努力就不可能做到这一点，我会完全理解。

Answer 1

我想要做的是自动获取 python 文件的文档字符串并将其放入文档而不执行整个文件。

你不能那样做。要从模块中获取文档字符串，需要导入模块。导入模块会执行整个文件。

如果您不希望在“简单导入”时执行代码，您可以使用基于 if __name__ == __name__ 块或 setuptools entry_point 的自动脚本生成。