我试图在Sphinx中为我的项目编写文档,每当Sphinx在模块中遇到OptionParser时,它就会给我:

我以为这是不可能的,所以我写了一个简单的模块检查一下:

from optparse import OptionParser

"""some comment here"""

parser = OptionParser(conflict_handler='resolve')
parser.add_option('', '--force', action='store_true', dest='force', default=False, help='gqdel will skip asking questions, and delete them all.');
parser.add_option('', '--verbose', action='store_true', dest='verbose', default=False, help='Report additional information from gqdel')

(options, args) = parser.parse_args()

"""and here"""

print "foo"
它给了我同样的错误。我的第一个样子是这样的:
some title
==========

.. automodule:: test
   :members:

最佳答案

这是我认为发生的情况:

Sphinx运行时,autodoc导入您的模块,并执行模块中的顶级代码。创建一个OptionParser实例,它处理传递给sphinx-build one of which is -b的命令行参数和选项。您的OptionParser不允许此选项。

我会将OptionParser代码放在函数中,以便在导入模块时不执行该代码。

关于python - OptionParser是否与Sphinx冲突?,我们在Stack Overflow上找到一个类似的问题:https://stackoverflow.com/questions/6912025/

10-11 03:56