Warning: file_get_contents(/data/phpspider/zhask/data//catemap/1/vue.js/6.json): failed to open stream: No such file or directory in /data/phpspider/zhask/libs/function.php on line 167

Warning: Invalid argument supplied for foreach() in /data/phpspider/zhask/libs/tag.function.php on line 1116

Notice: Undefined index: in /data/phpspider/zhask/libs/function.php on line 180

Warning: array_chunk() expects parameter 1 to be array, null given in /data/phpspider/zhask/libs/function.php on line 181
Python 文档脚本不是sphinx中模块的一部分_Python_Python Sphinx - Fatal编程技术网

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

Python 文档脚本不是sphinx中模块的一部分,python,python-sphinx,Python,Python Sphinx,我查找了几个软件包(sphinx gallery、autoprogram等等),但没有找到任何关于如何轻松使用python脚本中的docstring进行文档编制的信息。所以我想对一个特定的文件执行autodoc 有人知道用python脚本自动生成sphinx文档的可能性吗 就像我在脚本的开头有一个docstring,可能还有一些包含docstring的函数,我只想自动生成一些文档,就像我可以使用一样。。automodule::指令,但不幸的是,这对相对路径/脚本不起作用 编辑: 我想创建一些do

我查找了几个软件包(sphinx gallery、autoprogram等等),但没有找到任何关于如何轻松使用python脚本中的docstring进行文档编制的信息。所以我想对一个特定的文件执行
autodoc

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

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

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

编辑2: 好的,在重新阅读文档并尝试之后,我对这一点有了更清晰的认识。我想做的是自动获取python文件的docstring并将其放入文档,而不执行整个文件(因为出于某些原因,我不能或不想将所有内容隐藏在主例程后面)。我让autodoc记录了一个特定的文件(有一些错误的配置,为什么它不起作用),但正如文档中所述,它执行该文件。这才是我真正的问题。如果有一个解决方案可以实现这一点,我会很高兴,但如果不付出很大努力,这是不可能的,我会完全理解

我想做的是自动获取python文件的docstring并将其放入文档,而不执行整个文件

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


如果您不想在“简单导入”时执行代码,您可以使用
If\uuuuuu name\uuuu==\uuuuuuu name\uuuu
阻止或基于脚本的自动生成。

什么叫“找不到”?为什么你不能使用斯芬克斯自动程序?抱歉,编辑了问题:)您需要提供一个可复制的示例,否则请阅读autodocs文档中的第一个注释我仍然不明白为什么您不能使用sphinxcontrib自动编程。CLI脚本和“通常只有一些被cron作业调用的python脚本”之间有什么区别?@mzjn autoprogram需要某种argparse参数,我想记录一个脚本,它可以在没有用户输入的情况下执行某些操作。