Skip to main content
 首页 » 编程设计

python之文档脚本不是狮身人面像中模块的一部分

2025年01月19日10cmt

我查找了几个软件包(sphinx-gallery、autoprogram 等),但没有找到关于如何轻松地使用 python 脚本中的文档字符串来生成文档的信息。所以我想以某种方式对特定文件执行 autodoc。

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

就像我在脚本的开头有一个文档字符串,也许那里有一些带有文档字符串的函数,我只想自动生成一些文档,就像我可以用 .. automodule:: 指令一样,但是不幸的是,这不适用于相对路径/脚本。

编辑:

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

编辑2:

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

请您参考如下方法:

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

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

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