sphinx-build：错误：无法识别的参数：-b html build / doctrees source build / html

Question

我正在使用Sphinx来记录我的项目。当我正在运行时make html我收到了这个错误。

我已安装Sphinx v1.1.2。某些.rst文件中可能存在一些错误，但此错误消息无效，因为我不知道要检查哪个文件，因为我有超过100个.rst文件。因此很难逐个检查文件。

有没有办法解决这个错误或者至少找出哪个文件是错误的？

提前致谢。

Answer 1

检查此错误之前正在处理的模块。该模块可能缺少if __name__ == '__main__'检查。

这里的问题是：

• sphinx-apidoc（或者你用来生成rsts的任何东西）可能会把automodule / autoclass / ...放在你的第一个。
• 当sphinx在第一个文件中遇到autoXXX指令时，使用autodoc扩展名从teh .py文件中获取doc字符串。
• autodoc导入.py模块以从中提取doc字符串。
• on import如果某个模块默认假定它只是一个可执行文件（即没有__main__检查），那么你就会收到错误。

这是a $$错误的一个难点是，大多数开发人员会在错误的args上显示的错误消息中使用sys.argv[0]和sys.argv[0:]，导致打印出完全不合适的错误消息这种情况。

Answer 2

如果您使用的是sphinx-apidoc，并且您的软件包在同一文件夹中使用setuptools with setup.py，请务必将setup()调用隐藏到if 'main' == __name__:内。