python - 带有 Sphinx 的“意外章节标题”——是 numpy 问题吗？

Question

运行时

sphinx-build . html/

在我的 doc/ 目录中，我得到以下输出:

$ sphinx-build . html/
Running Sphinx v0.6.4
No builder selected, using default: html
loading pickled environment... done
building [html]: targets for 0 source files that are out of date
updating environment: 0 added, 1 changed, 0 removed
reading sources... [100%] index                 
reST markup error:
HIDDEN/PATH/matplotlib_visualization.py:docstring of simulator.extensions.matplotlib_visualization.beta:20: (SEVERE/4) Unexpected section title.

这个文件有 numpy 导入，经过一些研究，似乎 sphinx 使用的 RST 标记与记录 numpy 的方式有问题。当我取出 numpy 导入时，html 构建正常。

解决此问题的最佳方法是什么？

Answer 1

主题在这个线程中讨论: https://groups.google.com/d/msg/sphinx-users/MAFTlX8pAvk/B9hx7MuBVbIJ

皮埃尔总经理说:“弗雷德里克，看起来您正在为您的文档使用 thw numpy 标准。考虑然后使用 Pauli Virtanen 实现的 numpydoc 扩展:它是可在此处获取: http://sphinx.googlecode.com/svn/contrib/trunk/ "

关于 numpydoc 的当前信息:<德尔> https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

移动了有关 NumpyDoc 的信息:https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard