Sphinxの簡単な紹介

最初に

このプレゼンテーションは

• S6 (c) 2007 Cybozu Labs, Inc.
• Sphinx
• S6 Sphinxテーマ

で作成しました

Sphinxってなに？

文書作成ツール

reStructuredText -> 他フォーマット

• HTML
• latex
• pdf
• epub
• json

reStructuredTextってナニ？

markdownとかwiki記法のような軽量マークアップ言語の一つ

Sphinxの簡単な紹介
==================

.. s6:: styles

    h1: {fontSize:'450%', textAlign:'center', margin:'30% auto'}

最初に
------

このプレゼンテーションは

* S6 (c) 2007 Cybozu Labs, Inc.
* Sphinx
* S6 Sphinxテーマ

で作成しました

ナニが便利なのか？

• 継続的な文書のメンテナンス
• Python系のプロジェクトの文書は大体これ
• 製薬系のライブラリのオンラインヘルプもコレで書かれているのがある(C++)
• VCSと相性がいい
• 原稿書くのに使った(drkcore)

インストール方法

インストール

$ easy_install sphinx

quick-start

$ sphinx-quickstart

デモる？

Sphinxを使うと

• 文書を管理するのが楽になる
• もっと書く
• 長文気持ちいい
• もっと書く
• 好循環！

自分の例

• ソースコードリーディングのメモ(http://www.kzfmix.com/sphinx/)
• さくらのVPS設定メモ(http://www.kzfmix.com/sakura/)
• 富士市の情報をまとめたり(http://docs.fujinism.com/)
• blohgというrest+mercurrialなblog(http://www.fujinism.com/)

参考サイト

• Sphinx
• Sphinx-Users.jp