python sphinx文档化脚本,无py扩展

python sphinx文档化脚本,无py扩展,python,python-sphinx,Python,Python Sphinx,道歉-这是一个完整的n00b问题: 我有两个没有.py扩展名的python脚本 我如何说服Sphinx它应该记录该脚本?示例错误: /home/XXX/YYYYY/development/dst/build/index.rst:25:(警告/2)autodoc无法导入/查找模块“site_scons.random”,它报告错误:“没有名为random的模块”,请检查拼写和sys.path为了使脚本成为模块,它需要包含.py后缀。从: 模块是包含Python定义和语句的文件。文件名是附加后缀.py

道歉-这是一个完整的n00b问题:

我有两个没有.py扩展名的python脚本

我如何说服Sphinx它应该记录该脚本?示例错误:


/home/XXX/YYYYY/development/dst/build/index.rst:25:(警告/2)autodoc无法导入/查找模块“site_scons.random”,它报告错误:“没有名为random的模块”,请检查拼写和sys.path

为了使脚本成为模块,它需要包含
.py
后缀。从:

模块是包含Python定义和语句的文件。文件名是附加后缀
.py
的模块名


如果不给它后缀,Sphinx将无法导入它以使用
automodule

Cheers生成文档,因此Sphinx是一个模块文档包。令人惊讶的是,一定有很多脚本需要记录。回到绘图板。您可以使用它编写自己的文档。您不能将
automodule
用于非模块的东西。上的文档说明“如果您记录脚本(与库模块相反),请确保它们的主例程受到If name=='main'条件的保护。”这让我有了记录脚本的方法的希望。