Docstringを書こう!
- 17. docstring - NumPy style
17
def func(arg1, arg2):
"""
Parameters
----------
arg1 : 1
1
arg2 : 2
2
Returns
-------
"""
•
•
•
- 18. docstring - Google Style
18
def func(arg1, arg2):
"""
Args:
arg1 ( 1 ): 1
arg2 ( 2 ): 2
Returns:
:
"""
•
•
- 25. $ git clone git@github.com:pallets/flask.git
# 依存ライブラリのインストール
$ python seup.py install
25
sphinx-apidoc import
!!!
- 26. sphinx-apidoc
26
# 設定ファイルを作る & ドキュメントの雛形を生成
$ sphinx-apidoc -F -a -o ./doc ./flask
doc
├── Makefile
├── _build
├── _static
├── _templates
├── conf.py
├── flask.rst
必要に応じて
設定ファイルを書き換え