pythonのdocstringからのドキュメント作成。
例えば。
pythonソース用のrstファイルを以下のように用意すると、
良い感じにdocstringからドキュメントを作成してくれる。
1 2 3 4 5 6 7 8 9 10 11 |
ContractedHist module ===================== .. automodule:: ContractedHist :members: :undoc-members: :show-inheritance: .. autosummary:: ContractedHist |
標準だと init はドキュメント化されない。
special-members で指定しても良いけど、面倒なので
僕は initの引数や変数は class の方に書くようにしている。
各メソッドの引数や変数は、以下の様に書くことが出来る。
1 2 3 4 |
:param str freq: 集計する期間. (ex: 'M', 'W'...) :param list names: 集計する通貨のリスト.空リストならcontractに含まれる通貨全て. :param str method: 集計方法.'count'な% |