Sphinxでソフトウェアのドキュメントを書いた時によく使う記法
·1 分で読めます
最近Sphinxでよくドキュメントを書くのでメモ。やっぱりある程度巨大なソフトウェアのドキュメントを書く時はWikiじゃなくてSphinxの方が良い気がする。 リンク 他のファイルのセクションにリンクを貼るときには そのセクションの前で .. \_label: のようにラベル定義 :r
Sphinx
Sphinxで複数のman pageを生成する
·3 分で読めます
前置き つい最近tomahawk(https://github.com/oinume/tomahawk)のドキュメントをGithub WikiからSphinx(http://sphinx.pocoo.org/)に移行したのでそのメモ。SphinxにはHTMLを生成する以外にもman pageを生成す