Sphinx関係の記事をたくさん投稿してきたので、ここらでまとめてみます。
Sphinxとは
Sphinx(スフィンクス)とは、文章を書くためのツール(フレームワーク)
エディタとも、wikiとも分類しがたい、新たな書き方のツール。
Sphinx-Users.jp :: ドキュメンテーションツール スフィンクス Sphinx-users.jp
導入方法はこの記事を参照されたし。
Sphinx導入のメリット
利用すると、以下のことができるようになります。
- さまざまな形式で出力できる。(HTML,ePub,PDF,Word…) Sphinx-docxbuilderでWordドキュメントをテキストから生成(Windows) Sphinxからepub形式で出力して、Dropbox経由でiPadから読んでみる SphinxのPDF出力をrst2pdfで試す@Windows64bit Sphinxでテキストから変幻自在の出力結果比較(HTML,Word,PDF,ePub)
- 好きなエディタ(Emacs,Vim,Vi)をつかってテキストでかける。 EmacsでSphinxのrstファイルを編集するときの気に食わない白色をなんとかしたメモ SphinxのRSTファイル編集のためにrst.elをemacsに入れる
- gitやsvnなどで版数管理できる。 gitでSphinxのドキュメントを版数管理。commitでビルドさせた。
- プラクイン豊富!各種自動化が可能! git commitからJenkinsでSphinxドキュメントをビルド+α watchdog(watchmedo)でrst定期監視してsphinxビルド。