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

Pierre GM说： “弗雷德里克，看起来你正在使用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

与Sphinx一起出现的“意外的章节标题” - 问题是否存在？

1 个答案: