Sphinx-Users.jp
Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会
クイック検索
ドキュメントを作りたくなってしまう魔法のツール Sphinx
¶
Sphinx概要
プレーンテキストなソースコード
ページ間の相互リンク
強力なコードハイライト
拡張機能でさまざまなことができる
ドキュメントが日本語化されている
多くのドキュメントで使用されている
Sphinxの利用例
Sphinxのインストール
必要なもの
Sphinxプロジェクトの作成
reSTによるドキュメント作成
Sphinxによるドキュメントのビルド
応用例(1/2)
テンプレートの作成
Sphinx実用例
Sphinx拡張
Sphinxドメイン
sdedit (Quick Sequence Deiagram Editor)
blockdiag by @tk0miya
docx
まとめ
他のツールとの比較
Word
Excel
Wiki
Sphinx
成長しやすいドキュメントのヒミツ
背骨
子供を追加
toctreeの目次に内容を追加
構造を変えずに子供の分割
子供の並び替え
背骨の編集と各ページの変更を順番に行おう
神経ネットワーク
説明ユニット
目次
ドキュメント作りがサクサク進むしかけ
部分部分から攻める
全体像から攻める
読みやすさを考えてコツコツ頑張る
業務での利用事例
ドキュメント、書いていますか？
ドキュメントを書いている割合
ドキュメントが書けない開発現場
意味のあるドキュメントを書いている割合
問題と対策
簡単に書けるって何だろう？
書き方のルールを決めておく
読者のターゲット向けに大きく分ける
ドキュメントを書く手間を減らす
開始時に分かっている共有情報をあらかじめ書いておく
数ステップでドキュメントを書く環境を整えられるようにする
共有や閲覧の仕組みを自動化して開発プロセスに組み込む
デモ
ドキュメントステップアップ
必要な文章を必要な時に書くようにする
まず目的を書こう
能動的にドキュメントを書く動機付け
自動化のすゝめ
ドキュメント作成を開発サイクルに組み込む
全体が繋がる楽しさ！
ドキュメントポートフォーリオへの昇華
まとめ
Sphinx リファレンスマニュアル
Docutils(reST) マニュアル
早わかりreStructuredText
索引
Table Of Contents
Sphinx技術情報
Sphinxをはじめよう
逆引き辞典
Sphinxクックブック
ドキュメント資料集
Sphinxハッキングガイド
発表資料
Sphinxの歴史
外部リンク集
コミュニティ情報
Sphinx-Users.jp一問一答
ミッションステートメント
参加するには？
必要なスキルは？
コミュニケーション
イベント
sphinx-users.jp 会則
活用事例
Sphinxを使用しているサイト
Sphinxテンプレート
Sphinxを使用して執筆された書籍
前のトピックへ
日本UNIXユーザ会 2010年12月勉強会 (2010/12/3)
次のトピックへ
Sphinx概要
このページ
ソースコードを表示
Tweets by sphinxjp