回答編集履歴
1
URLをリンクに。リンクの説明を訂正
answer
CHANGED
@@ -3,7 +3,7 @@
|
|
3
3
|
Python本体は、info field listに頼らずに書こうという方針が出たようで、SphinxでドキュメントをHTML化等していますがinfo field list形式では書かれていません。歴史的にはPython本体のdocstringのほうが先に存在しているというのもあります。
|
4
4
|
|
5
5
|
これ以外の書式として、Googleのdocstring形式やnumpyの形式があります。
|
6
|
-
-
|
6
|
+
- [http://www.sphinx-doc.org/ja/stable/ext/napoleon.html](http://www.sphinx-doc.org/ja/stable/ext/napoleon.html)
|
7
7
|
|
8
8
|
楽に書けて、SphinxでHTML化したときに見栄えがよいのはどれか、という意味では、Python本体以外のrequests, google, numpy等のフォーマットとがよさそうですが、Sphinxを使わないのであればどれでも構わない気もします。
|
9
9
|
|