文档脚本不是sphinx中模块的一部分

Question

我找了几个包（sphinx gallery、autoprogram，…），但没有找到如何轻松地使用python脚本中的docstring作为文档。所以我想对一个特定的文件做autodoc。在

有人意识到了从python脚本自动生成sphinx文档的可能性吗？在

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

编辑：

我想创建一些docstring的脚本不是cli脚本，它只是一些python脚本，它们通常由cron作业调用。不幸的是，据我所知，自动程序在这里没有帮助。在

编辑2:

好吧，在重新阅读了文档并尝试了一下之后，我对这一点有了一点了解。我想做的是自动获取python文件的docstring并将其放入文档中，而不执行整个文件（因为某些原因，我不能或不想将所有内容隐藏在主例程后面）。我让autodoc记录一个特定的文件（有一些错误的配置为什么不起作用），但是就像它的文档中所说的那样，它执行这个文件。这才是我真正的问题。如果有人能解决这个问题，我会很高兴的，但我会完全理解如果没有大的努力这是不可能的。在

Answer 1

What I wanted to do is automatically taking the docstring of a python file and put that to documentation without executing the whole file.

你不能那样做。要从模块获取docstring，需要导入该模块。导入模块将执行整个文件。在

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