https://journal.lampetty.net/categories/sphinx/ Recent content in Sphinx on oinume journal Hugo ja Sun, 21 Apr 2013 13:04:00 +0900 https://journal.lampetty.net/posts/wp/521/ Sun, 21 Apr 2013 13:04:00 +0900 https://journal.lampetty.net/posts/wp/521/ <p>最近Sphinxでよくドキュメントを書くのでメモ。やっぱりある程度巨大なソフトウェアのドキュメントを書く時はWikiじゃなくてSphinxの方が良い気がする。</p> https://journal.lampetty.net/posts/wp/437/ Fri, 06 Jan 2012 21:01:40 +0900 https://journal.lampetty.net/posts/wp/437/ <h3 id="前置き">前置き</h3> <p>つい最近<a href="https://github.com/oinume/tomahawk">tomahawk</a>のドキュメントをGithub Wikiから<a href="http://sphinx.pocoo.org/">Sphinx</a>に移行したのでそのメモ。SphinxにはHTMLを生成する以外にもman pageを生成する機能があって</p> <p>$ make man</p> <p>を実行すると _build/man/ 配下に mycommand.1 みたいな感じでman pageが生成される。</p> <p>でで、tomahawkの場合は tomahawk, tomahawk-rsync という２つの実行ファイルがあるので、この2つのman pageを生成したくて、tomahawk.rst, tomahawk-rsync.rst ファイルを作ってみたけど、デフォルトでは tomahawk.1 に全部入りのman pageができるだけで「独立したrstファイルから個別のman page生成するのってどうやるんだろう？」となっていた。</p>