在Sphinx中嵌入matplotlib图:如何显示文档

时间:2015-05-22 12:59:46

标签: python matplotlib ipython python-sphinx

我有一些ipynb文档,其中matplotlib图显示为%matplotlib inline指令。

当我尝试使用内联绘制的图表显示我的笔记本时,我有我的Sphinx文档。我尝试使用

ipython nbconvert shalom.ipynb --to rst

但是,它确实给了我一个没有任何内嵌图形的RST。只有代码清单。

难道你不能告诉我,如何使用已经渲染的图表生成Sphinx文档。

我知道这是可能的。

1 个答案:

答案 0 :(得分:1)

您需要使用Sphinx extensions for embedded plots, math and more

  

Sphinx是用python编写的,并且支持编写自定义的功能   扩展。我们为matplotlib文档编写了一些文档,其中一些   其中matplotlib本身是matplotlib.sphinxext中的一部分   模块,其中一些仅包含在sphinx doc目录中,   还有其他组写的其他扩展名,例如numpy和   IPython中。我们将在本教程中收集这些内容并向您展示如何操作   为您自己的项目安装和使用它们。首先让我们抓住   来自git的sphinxext目录的python扩展文件(参见   获取数据),并将它们安装在我们的samplingoc项目中   sphinxext目录:

您需要修改conf.py以包含:

extensions = [
          'matplotlib.sphinxext.mathmpl',
          'matplotlib.sphinxext.only_directives',
          'matplotlib.sphinxext.plot_directive',
          'matplotlib.sphinxext.ipython_directive',
          'sphinx.ext.autodoc',
          'sphinx.ext.doctest',
          'ipython_console_highlighting',
          'inheritance_diagram',
          'numpydoc']