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



我查找了几个软件包(sphinx-gallery,autoprogram,...),但没有找到有关如何轻松地使用python脚本中的文档字符串进行文档的任何说明。所以我不知何故想对特定文件进行autodoc

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

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

编辑:

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

编辑2:

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

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

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

如果不希望在"简单导入"时执行代码,则可以使用基于if __name__ == __name__块或基于entry_point自动生成脚本的设置工具。

相关内容

最新更新