python - OptionParser 是否与 Sphinx 冲突？

Question

我正在尝试为我在 Sphinx 中的项目编写文档，每当 Sphinx 在我的模块中遇到 OptionParser 时，它都会给我:

sphinx-build: error: no such option: -b

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

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:

Answer 1

这是我认为会发生的情况:

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

我会将 OptionParser 代码放在一个函数中，这样它就不会在导入模块时执行。