SphinxConJP 2012 (世界ではじめてのSphinxカンファレンス) 参加レポート
SphinxConJP 2012 が本日開催され、計7件のセッションがありました。それぞれスライド内容をレポートとしてまとめました。
Sphinx ではじめるドキュメント生活 2012 @tk0miya 15:15-15:40
- Sphinxについて
- テキストから各種フォーマットへの変換 (HTML, PDF)
- Welcome to PEP翻訳 — PEP翻訳 v3642 documentation
- シンプルなマークアップ (reST) Wiki記法みたいなもの
- 目次ベースなので文章が書きやすい
- Sphinxのよいところ
- ソースがテキスト形式 なので
- schema2rst (DB定義抽出)
- いまいちなところ
- 変換する必要がある（ビルド) Jenkinsなどで自動化はできる
- reSTは文書レイアウトを表現できない
- 画像や図などは別途作る必要がある
- 主な用途
- 開発ドキュメント、Webサイト、出版
- Sphinxの現在
- Sphinxの未来
- PDFのパッチ取り込み、変換の自動化、PDFテーマ
- テーマや拡張を増やす、Webエディタ、利用事例
- Sphinxコミュニティの紹介
- まとめ
- #sphinxjp で質問したら誰か共有。面白いネタを提供してください
Sphinx拡張 探訪 @r_rudi 15:40-16:05
Sphinx拡張 探訪 — SphinxCon 2012 documentation
SphinxCon 2012で発表してきました。 / tdoc.info/blog/2012/09/1… #sphinxconjp #sphinxjp #pyconjp
— しろうさん (@r_rudi) 9月 17, 2012- 自己紹介
- dipus お手軽全文検索サーバー Dipus - (主にSphinx向け) 全文検索サーバー — そこはかとなく書くよん。
- 拡張について
-
- テーマ
- 7種類が標準。拡張として sphinxjp.themecore
- sphinxjp.themes.htmlslide
- sphinxjp.themes.solarized
- cloud_sptheme (Beautiful soap のサイト)
- テーマ
-
- グラフなど描画系
- blockdiag,, gnuplot, graphbiz, googlechart, nicovideo, ...
- sphinxcontrib-aafig
- sphinxjp.shibukawa カレンダー描画
- グラフなど描画系
-
- excelなどの変換系
- wiki2sphinx odt2sphinx など
- sphinxcontrib-exceltable Excel ファイル指定できる
- sphinx-git
- excelなどの変換系
-
- Django/Zopeなどとの連携
- 試してません>
- Django/Zopeなどとの連携
Sphinx HTML theme 事始め @shkumagai 16:45-17:10
SphinxCon JP 2012 で使った資料を Github Pages で公開しました。bit.ly/O8i4Wd #pyconjp #sphinxconjp
— バナナはおやつに含みません。さん (@shkumagai) 9月 17, 2012- HTMLテーマとは何か
- HTMLテンプレートとCSSの集まり
- conf.py html_theme
- 組み込みHTMLテーマの簡単なカスタマイズ
- 背景色だけ変更したい html_theme_options (辞書型のパラメータ)
- テーマごとにoptionがある
- テーマと設定可能なoption
- サイドバーを隠したい ( "nosidebar": True )
- default のテーマの option
- テーマをつくる
- theme.conf
- [theme] セクション
- inherit 継承
- stylesheet
- [theme] セクション
- theme.conf
- まとめ
- HTMLテーマサポート の公式ドキュメント
Sphinxを使って本を書こう @shimizukawa 17:10-17:35
#pyconjp の資料をUploadしました / Sphinxを使って本を書こう on @slideshare slideshare.net/shimizukawa/sp…
— Takayuki Shimizukawaさん (@shimizukawa) 9月 17, 2012
- 作者: Tarek Ziade,稲田直哉,渋川よしき,清水川貴之,森本哲也
- 出版社/メーカー: アスキー・メディアワークス
- 発売日: 2010/05/28
- メディア: 大型本
- 購入: 32人 クリック: 722回
- この商品を含むブログ (87件) を見る
- 作者: ビープラウド
- 出版社/メーカー: 秀和システム
- 発売日: 2012/03/26
- メディア: 単行本
- 購入: 3人 クリック: 729回
- この商品を含むブログ (17件) を見る
Sphinxの平凡な使い方 ～業務での利用事例～ @usaturn 17:45-18:00
Sphinxの使い方事例 from Go Yamada
- 事例その１ スマートなファイル管理
- 事例その２ 簡単にWebサイトをつくりたい
社内でのSphinx、reSTの広め方 @takanory 18:00-18:15
- How to spread reST and Sphinx
- MS-Word 使いたくない、らくしたい、reSTで書きたい
- 1st step 議事録を書く→メール→なんとなく記法に慣れる
- 心の中にフォーマッターができてくる
- 2nd step Plone*1 + ReST
- 議事録を書く、週報を書く（→相互に書き込み）
- Plone は Sphinxより検索が賢い。全文検索
- 普段からreSTを使うようになる , 楽しく書く, 他の人を真似する
- 3rd step Sphinx
- チームで資料（要件定義）を書く / 書くことに集中 / 設定したい人は使えるようにする
- チームでドキュメント
- Sphinxのファイル構成を全部作る
- タイトルと担当者をすべて入れる
- 目次だけできている状態
- まとめ
- みんなでドキュメントができた！
- make html で Warning が消せない問題→たいていは下線が短い、改行がないとか→ひとりで面倒をみた
- 徐々にひろめる、書くことに集中してもらう、最後は自分で面倒をみる
Sphinxにおけるdocutilsの役割 @hekyou Keita Uchiyama 18:15-18:30
SphinxCon JP 2012で発表させて頂きました -bit.ly/U41ise #pyconjp #sphinxconjp #sphinxjp
— へきょさん (@hekyou) 9月 17, 2012- DocutilsでHTMLを生成してみよう
- Sphinx インストールで、 docutils も入る
- rst2html.py foo.rst > foo.html
