Published on

Link: Numpy docstring / Howto

Authors
  • avatar
    Name
    tuxedocat
    Twitter

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

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

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

Sphinx: Numpy Style Docstring