問題タブ [numpydoc]
For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.
python-sphinx - Python Docstring の段落の後の箇条書きリストが sphinx と numpydoc で機能しないことがある
numpyスタイルを使用して Python モジュールを文書化し、 sphinxとnumpydoc拡張機能を使用して HTML ドキュメントを生成しているときに、箇条書きに関するバグ (または機能?) に遭遇しました。
reStructuredText リファレンスによると、箇条書きリストには前後に空行が必要です。
したがって、私が知りたいのは、最初のバージョンが機能するのはなぜですか (機能しないのに)、2 番目のバージョン (機能しない) と何が大きく異なるのですか?
編集：
生成された html では、最初と最後のバージョンで外観が異なります。先頭の空行のない箇条書きリストの外観が必要な場合 (html のスペースが少ない場合)、クイックフィックスを使用できます。
これにより解析エラーが回避されますが、それでも理由の質問には答えられません :-)
python - autosummary「toctree に存在しないドキュメントへの参照が含まれています」という警告
このスレッドと同じ問題に直面しています。Sphinx ドキュメントをビルドすると、make htmlこのような警告がたくさん表示されます
を使用してhtml_theme = 'sphinx_rtd_theme'います。に変更するとclassic、警告は表示されません。に追加numpydoc_show_class_members = Falseするとconf.py、それらも取得できません。
しかし; 私は本当に好きsphinx_rtd_themeで、 を使用classicまたは追加すると、Python メソッドnumpydoc_show_class_members = Falseの「TOC」が削除されます。
carsモジュールのドキュメントは
モジュールには、2 つのメソッドを持つ 1 つのクラスが含まれていCarます。docstring は で書かれていnumpydocます。
python - コードとドキュメントの一致を確認する
Sphinx拡張NumpyDocを使用して、ドキュメントがドキュメント化されているコードと一致することを自動的に確認する方法はありますか?
たとえば、次のドキュメントはタイプミスによりコードと一致しません。
Sphinx または NumpyDoc でこれをエラーにすることはできますか?