Sphinx意外的部分标题 - numpydoc

时间:2016-02-12 15:06:10

标签: python numpy python-sphinx

我无法使用numpy格式正确使用Sphinx。 我正在使用此example进行测试,执行" make html",但我收到了几个警告来识别参数,注释,返回等。例如:

SEVERE: Unexpected section title.
ERROR: Unexpected indentation.
also
WARNING: Inline emphasis start-string without end-string.
WARNING: Literal block expected; none found

这个问题已经被提出,但在搜索并尝试了几个小时后我没有成功。

到目前为止我做了什么:

  • 已安装Sphinx v1.3.5
  • numpydoc更新为版本0.5
  • 将扩展程序numpydocsphinxcontrib.napoleonsphinx.ext.napoleon添加到conf.py文件中。
  • 尝试了rst2html docum.txt docum.html
  • 由于我认为它没有使用numydoc,我写了一个不正确的名称作为扩展名,它给出了一个错误(因为它应该是,所以我认为它正在识别numpydoc)。
  • numpydoc_show_class_members = False添加到conf.py
  • 删除整个以前的html输出

有什么建议或提示是什么问题?我能尝试什么?

由于

1 个答案:

答案 0 :(得分:1)

问题是我使用numpydoc直接用.. toctree:: filename来记录模块,但它必须与.. automodule:: filename一起使用。有关如何在此处使用它的更多信息:http://www.sphinx-doc.org/en/stable/tutorial.html#setting-up-the-documentation-sources。谢谢你的帮助。