python-sphinx记录没有py扩展名的脚本

时间:2014-01-08 17:56:36

标签: python python-sphinx

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

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

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

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

1 个答案:

答案 0 :(得分:0)

为了使您的脚本成为模块,它需要包含.py后缀。来自Python docs

  

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

如果不给它后缀,Sphinx将无法使用automodule导入它来生成文档。