Warning: file_get_contents(/data/phpspider/zhask/data//catemap/2/python/298.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来记录整个项目文件夹,其中有很多子文件夹和python脚本 自动化此过程的最佳解决方案是什么?项目将不断更新,文件应适当更新 使用python制作一个例程来创建大量的.rst文件,再加上automoduleSphinx指令来捕获docstring 在index.rst中使用一些Sphinx指令,以便自动获取文件夹和查找所有脚本(是否有类似的内容?) 斯芬克斯文档很难理解,我没有找到我想要的东西 你能帮我找到在哪里寻找解决方案吗 谢谢大家! 创建一个脚本来实现这一点,并将

我必须使用Sphinx来记录整个项目文件夹,其中有很多子文件夹和python脚本

自动化此过程的最佳解决方案是什么?项目将不断更新,文件应适当更新

  • 使用python制作一个例程来创建大量的
    .rst
    文件,再加上
    automodule
    Sphinx指令来捕获docstring
  • index.rst中使用一些Sphinx指令,以便自动获取文件夹和查找所有脚本(是否有类似的内容?
斯芬克斯文档很难理解,我没有找到我想要的东西

你能帮我找到在哪里寻找解决方案吗


谢谢大家!

创建一个脚本来实现这一点,并将其放在cron作业中。您可以使用sphinxapidoc:或者这个扩展名:谢谢,mzjn!在写了这篇文章之后,我找到了apidoc,但我仍在学习如何使用它,因为其他一些问题正在发生。如果问题持续存在,我会为此创建一个帖子,我不知道autopackagesummary,这听起来也不错。如果我的解决方案使用apidoc(它没有最好的文档…),我将尝试autopackagesummary。谢谢创建一个脚本来实现这一点,并将其放在cron作业中。您可以使用sphinxapidoc:或者这个扩展名:谢谢,mzjn!在写了这篇文章之后,我找到了apidoc,但我仍在学习如何使用它,因为其他一些问题正在发生。如果问题持续存在,我会为此创建一个帖子,我不知道autopackagesummary,这听起来也不错。如果我的解决方案使用apidoc(它没有最好的文档…),我将尝试autopackagesummary。谢谢