Subscribed unsubscribe Subscribe Subscribe

oinume journal

Scratchpad of what I learned

Sphinxでソフトウェアのドキュメントを書いた時によく使う記法

最近Sphinxでよくドキュメントを書くのでメモ。やっぱりある程度巨大なソフトウェアのドキュメントを書く時はWikiじゃなくてSphinxの方が良い気がする。 リンク 他のファイルのセクションにリンクを貼るときには そのセクションの前で .. _label: のようにラ…

Sphinxで複数のman pageを生成する

前置き つい最近tomahawkのドキュメントをGithub WikiからSphinxに移行したのでそのメモ。SphinxにはHTMLを生成する以外にもman pageを生成する機能があって $ make man を実行すると _build/man/ 配下に mycommand.1 みたいな感じでman pageが生成される。 …