September 13, 2015

Link: Numpy docstring / Howto

https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

ちゃんとDocstrings書こうと思ったとき,いつもどの流派の書き方でやればいいのか迷ってしまう.そしてその後は結局,Numpy派をお手本にして書いていた気がするので,今後はこの手間を省略できるように,記録しておく.(大げさな感じ…)

Sphinxもやりたい.SphinxだけではなくPandocやもっと最近の色々なものなど,Documentation周りのことに興味を持っている.学際領域っぽい魅力があるからかもしれない.(ただしTeXは難しすぎてあきらめている.)

Sphinx: Numpy Style Docstring

©2011-2018 tuxedocat