从Sphinx中的脚本中获取文档字符串

时间:2018-01-26 10:37:46

标签: python python-sphinx restructuredtext

我有一个代码库,它是模块和分析脚本的混合体。我试图用Sphinx记录它。

-MyProject
    -MyModule
    -Scripts_using_MyModule
        -Specific_Analytical_Question_1.py
        -Specific_Analytical_Question_2.py 

使用.. automodule::我可以从MyModule文件夹中的模块中获取文档字符串。但我还想采用我在脚本中编写的文档字符串。我的意思是脚本是用于特定目的的一小段代码,它们不是作为函数编写的,因此您可以在Spyder中运行时查看所有变量。

有没有办法为Sphinx提供文件夹名称并让它列出所有带有文档字符串的文件?

0 个答案:

没有答案