BPstudy#64でSphinxの紹介をしてきましたが、完成度の低さの自戒を込めてのupload

1. BPstudy#64
Sphinx-users.jp
山田剛

2. お前誰よ：山田 剛
Twitter: @usaturn
 仕事
 (株) ネットサポート所属
 アウトソーシング業を営むIT企業
 参加コミュニティ(勉強会)
 Python系
 Mercurial系
 Vim系
 アジャイル系
 その他
 インフラ系エンジニア
 sh、awk、vbs等は使えますが汎用言語の経験無し
 “改善”、”効率化”が好き。というか楽したい

3. アジェンダ
1. Sphinxってどんな物？
2. Sphinxを使ってみよう！
3. 既存のドキュメンテーションツールとの
比較
4. 利用例

4. 1. Sphinxってどんな物？
2. Sphinxを使ってみよう！
3. 既存のドキュメンテーションツールとの
比較
4. 利用例

5. Sphinxってどんな物？
ソースコードをプレーンテキスト
で作成するドキュメンテーション
ツール
ソースコードから色々なフォーマットに出力
する事が可能
reStructuredTextという記法でソースコード
を作成

6. 豊富な出力フォーマット
 html
 latex
 pdf
 json
 htmlhelp
 epub
 text
 man
.......etc

7. reStructuredText
reStructuredText(以下reST)
という、Wikiに似た記法でマー
クアップをしていきます。

8. 1. Sphinxってどんな物？
2. Sphinxを使ってみよう！
3. 既存のドキュメンテーションツールとの
比較
4. 利用例

9. Sphinxを使ってみよう！
インストール～実際にドキュ
メントを作成していく所まで
をご説明します。

10. 1. Sphinxってどんな物？
2. Sphinxを使ってみよう！
3. 既存のドキュメンテーションツールとの
比較
4. 利用例

11. 既存のドキュメンテーションツール
との比較
よく比較されるツールとして下記があげら
れます。
Excel
Word
Wiki

12. Excelの特徴
便利なExcel
誰でも使える（事になっている）
手軽にお絵かき
後で修正しにくいという一面が・・・

13. Wordの特徴
ドキュメント作成専用ツールWord
誰でも使える（事になっている）
手軽にお絵かき
単体でバージョン管理、マージ等も可能。
アウトライン
余計なお世話機能 非常に高機能な反面複
雑で習得し辛い

14. Wikiの特徴
Wikiクローン
（pukiwiki、Mediawiki、TracWiki…etc）
比較的簡単な記法
Webサーバが必要
バージョン管理やアカウント制御等、機
能豊富
自由度が高いので、ルールを決めて使う
必要がある。

15. Sphinxの特徴
プレーンテキストである為に、バージョ
ン管理しやすい -> 複数人で編集しやす
い！
toctreeにより階層構造を促され、文書作
成が横道にそれにくい
文書の分割、結合が楽
さまざまな拡張があり、拡張を自身で作
成する事も可能

16. 1. Sphinxってどんな物？
2. Sphinxを使ってみよう！
3. 既存のドキュメンテーションツールとの
比較
4. 利用例

17. 1. Sphinxってどんな物？
2. Sphinxを使ってみよう！
3. 既存のドキュメンテーションツールとの
比較
4. 利用例

18. 利用例
 利用例さまざまなオープンソースのプロ
ジェクトで利用されています。
http://sphinx-users.jp/example.html

19. 終わりに
Sphinxの魅力は伝わりました
でしょうか。少しでも興味が
湧いた方は是非、新しいド
キュメンテーション作成の初
めの一歩を踏み出してみませ
んか？