4

実行時

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.

このファイルにはインポートがあり、少し調査したところ、sphinx が使用する RST マークアップの文書化numpyの方法に問題があるようです。numpynumpy インポートを取り出すと、html が正常にビルドされます。

この問題を解決する最善の方法は何ですか?

4

1 に答える 1

5

主題はこのスレッドで議論されています：https： //groups.google.com/d/msg/sphinx-users/MAFTlX8pAvk/B9hx7MuBVbIJ

Pierre GMは、次のように述べています。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

于 2011-03-30T00:17:56.327 に答える