ひとりsphinx
- 1. ひとりSphinx 2011/07/22 odstudy #1 @togakushi
- 3. アジェンダ • Shpinxってなぁに？ • こんなひとにおすすめ！ • スモールスタートで始めてみよう • 使って嬉しいこと • まとめ
- 4. Sphinxってなぁに？ カッコイイドキュメントが作れるドキュメンテーションビルダ ー 特徴： • 軽量＆シンプル • 1つのプレーンテキストから様々なアウトプットが可能 • reStructuredText(reST) • 拡張機能 使われてるところ： • Python 2.6 公式ドキュメント • などなど...
- 5. Sphinxでなにができるの？ 出展：http://sphinx-users.jp/event/20101203_jus_benkyoukai/what_is/index.html
- 6. reSTサンプル Sphinxのサンプル ================= Sphinxとは何か？ ----------------- * ドキュメント生成のツール * reStructuredText記法(Wikiっぽい? * ページ間のリンクを自動生成 * 強力なコードハイライト * HTML, PDF, ePub, htmlhelp, latex, man...
- 7. こんなひとにオススメ！ • エクセルきらい！ワードきらい！な人 • テキストエディタだいすきー！な人 • 普段からメモはテキストで残す人 • 必要なときにドキュメントが見つけられない人 • 後から書こうと思っていつも書かない人 • ドキュメントにネガティブなイメージを持ってる人
- 8. スモールスタートで初めてみよう • インストールは簡単 o Pythonが動く環境なら3分 o Windowsにも一括インストーラーあり • ひとりで使っても効果抜群 o 書き散らかしたものがまとまる o 継続して書いても苦痛じゃない o 自分だけの辞書のようなものが出来上がる
- 9. 使って嬉しいこと • 普段使ってるツールの延長線上にドキュメントがある • 小さなドキュメントが大きく「成長する」過程が楽しめる • 書いてて楽しい、カッコいい • ドキュメント全体の見通しが良くなる
- 10. ちょっと不便なところ • 目的の出力までにワンクッションある • 慣れないうちは今書いてるドキュメントのアウトプットが どうなるか気になって仕方ない • マルチバイトのファイル名に弱い
- 11. まとめ • まずは小さく初めてみてください • 溜め込んでるドキュメントが大きく成長していきます • 公開したくなったらしてみましょう • たくさん書くと自分なりのポートフォリオができあがりま す • イイネ！と言ってくれる仲間がいればどんどん巻き込みま しょう
- 12. 参考資料 • Sphinx-users.jp • スタンドアロンインストーラー(Windows用一括インストーラー) • エキスパートPython（10章：プロジェクトのドキュメント作成） • 元ネタ：ひとりwiki
- 13. ご清聴ありがとうございました