Sphinx autodoc on readthedocs: ImportError: No module named _tkinter

Question

我正在尝试在 https://readthedocs.org/ 上构建文档。

我看不到任何导入 matplotlib 的文件的文档字符串。

当我查看构建日志时，我看到 from matplotlib import pyplot as plt 失败，并显示消息：

/home/docs/checkouts/readthedocs.org/user_builds/artemis-ml/checkouts/latest/docs/source/plotting.rst:67: WARNING: autodoc: failed to import function u'dbplot' from module u'artemis.plotting.db_plotting'; the following exception was raised:
Traceback (most recent call last):
  File "/home/docs/checkouts/readthedocs.org/user_builds/artemis-ml/envs/latest/lib/python2.7/site-packages/sphinx/ext/autodoc.py", line 551, in import_object
    __import__(self.modname)
  File "/home/docs/checkouts/readthedocs.org/user_builds/artemis-ml/envs/latest/lib/python2.7/site-packages/artemis_ml-1.6-py2.7.egg/artemis/plotting/db_plotting.py", line 3, in <module>
    from artemis.plotting.matplotlib_backend import BarPlot
  File "/home/docs/checkouts/readthedocs.org/user_builds/artemis-ml/envs/latest/lib/python2.7/site-packages/artemis_ml-1.6-py2.7.egg/artemis/plotting/matplotlib_backend.py", line 7, in <module>
    from matplotlib import pyplot as plt
  File "/home/docs/checkouts/readthedocs.org/user_builds/artemis-ml/envs/latest/lib/python2.7/site-packages/matplotlib/pyplot.py", line 115, in <module>
    _backend_mod, new_figure_manager, draw_if_interactive, _show = pylab_setup()
  File "/home/docs/checkouts/readthedocs.org/user_builds/artemis-ml/envs/latest/lib/python2.7/site-packages/matplotlib/backends/__init__.py", line 32, in pylab_setup
    globals(),locals(),[backend_name],0)
  File "/home/docs/checkouts/readthedocs.org/user_builds/artemis-ml/envs/latest/lib/python2.7/site-packages/matplotlib/backends/backend_tkagg.py", line 6, in <module>
    from six.moves import tkinter as Tk
  File "/home/docs/checkouts/readthedocs.org/user_builds/artemis-ml/envs/latest/lib/python2.7/site-packages/six.py", line 203, in load_module
    mod = mod._resolve()
  File "/home/docs/checkouts/readthedocs.org/user_builds/artemis-ml/envs/latest/lib/python2.7/site-packages/six.py", line 115, in _resolve
    return _import_module(self.mod)
  File "/home/docs/checkouts/readthedocs.org/user_builds/artemis-ml/envs/latest/lib/python2.7/site-packages/six.py", line 82, in _import_module
    __import__(name)
  File "/home/docs/.pyenv/versions/2.7.13/lib/python2.7/lib-tk/Tkinter.py", line 39, in <module>
    import _tkinter # If this fails your Python may not be configured for Tk
ImportError: No module named _tkinter

我已经指定（在 readthedocs 管理 > 高级设置）页面，以便：

该项目应该在 virtualenv 中构建
项目应该使用包含 matplotlib 的 requirements.txt 文件构建。您还可以从上面的消息中看到它已安装 - 显然不正确。

有人运行以前遇到过这个问题并且知道如何解决它吗？

Tkinter: "Python may not be configured for Tk" 中的答案没有帮助，因为这是关于 readthedocs 的。

Answer 1

您可以通过模拟导入解决此问题。

Sphinx 提供此功能以自动生成文档here。只需写在 conf.py

的开头

autodoc_mock_imports = ['_tkinter']

这里有一个例子：https://github.com/scopus-api/scopus/blob/4bb7f62f7a94e652f77515c94e7e0bab0d07cce7/docs/conf.py#L24

Answer 2

MERose 的解决方案可能是最好的，但如果它在这里不起作用，还有另一个对我有用的解决方法：

你可以让 sphinx 使用 import matplotlib 和 'agg' 后端，不需要 tkinter，打开 <project root>/docs/source/conf.py 并插入以下行：

import matplotlib
matplotlib.use('agg')

最后。

Answer 3

导致导入错误的包需要安装在您的机器上！我试图在另一台电脑上创建文档，但并未安装我项目中包含的所有软件包，当然这引发了导入错误。

也许我只是在这里指出了显而易见的问题，但我花了很长时间才弄清楚这就是问题所在。

Sphinx autodoc on readthedocs: ImportError: No module named _tkinter

Sphinx autodoc on readthedocs: ImportError: No module named _tkinter

python

tkinter

matplotlib

read-the-docs