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 Admin＆gt;高级设置中）页面，以便：

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

之前有人遇到过这个并知道如何修复它吗？

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

Answer 1

您可以使用模拟导入来解决此问题。

Sphinx提供此功能以自动生成文档，如here所述。只需在autodoc_mock_imports = ['_tkinter']

的开头写下即可

{{1}}

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

Answer 2

MERose的解决方案可能是最好的，但是如果它不起作用，那么另一种解决方法对我有用：

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

import matplotlib
matplotlib.use('agg')

最后。

readthedocs上的Sphinx autodoc：ImportError：没有名为_tkinter的模块

2 个答案: