読者です 読者をやめる 読者になる 読者になる

Sphinxを使ってプログラムドキュメントを楽しく書こう

tech

今日はソフトウェアのドキュメントツールの紹介です。

ソフトウェアってプログラムだけじゃなくて、「テスト」と「ドキュメント」も大事だなと最近思うようになってきました。

僕は今までプログラムは書いてきたけど、テストもドキュメントもさっぱりでした。なのでそこら辺も勉強していこうと思って、まずはドキュメントを書いてみようと。で、書くならやっぱり楽で綺麗で便利なのがいいなーと思って調べてたらSphinxというツールが便利そうだったので使ってみています。

ただSphinxは機能概念的なところが少しわかりにくいところがあるので、自分の理解を整理するためにまとめてみました。

より詳しいドキュメントは日本のユーザサイトを見てみるといいと思います。Sphinx-JP


SphinxいいよSphinx。ドキュメント書くの楽しいよ。でもMarkdownよりはやれることが多い分、ちょっと複雑かなという印象です。

次はJavaScriptのテストはどうやるかも勉強しよう。