2018年以降の記事はGitHub Pagesに移行しました

kawasaki.rb #013 でSphinx導入事例の発表をしてきました と #011 #012 参加記録 #kwskrb #sphinxjp

あらすじ

kawasaki.rb に参加したものの記録を取っていなかったのでまとめて。

13回目ではSphinxを話をしたのでその備忘録。Ruby系の勉強会だけどRuby以外の発表でも大丈夫。

発表内容

以下のスライドを元にLTしました。

Sphinxを使用したドキュメント作成をする機会を探っていて、ようやくドンピシャで導入できるプロジェクトをこの手で手繰り寄せたのでそこで得た知見をまとめました。

大体の内容はこの辺から参照してます。

ねらい

  • 「なんとか設計書_日付_リビジョン(だれそれ更新分)(最新版).xls」 とかいう差分取りづらい伝説のファイルが共有サーバ上に量産されるの辛い…
  • 共有サーバに上記のようなファイルがちらかるのでどこに何があるかわかりにくい
  • ミリ単位のレイアウト調整に苦心するのやだ

という事で

  • プレーンテキストで文書を作成できる
  • 文書を体系立てて管理できる
  • デザインなどはアウトプット時におまかせ

できるSphinxを導入しようというもの。

なぜSphinxがいいのかというところを競合するツールと比較してみたところまでを発表しました。

次の発表で「導入する際、導入した後に気をつけた事」とか発表する予定です。

おまけ 11回目、12回目で起こったこと

  • ロゴができた
  • kawasaki.rbのGitHub Pagesができた(Powered by Jekyllだ!)
  • kawasaki.rbのリポジトリに対して参加者がPRしまくり

他、所見。

  • Jekyll の翻訳で得た知見あたりを発表したいなーとも考えている
  • 12回目の懇親会で食べた「じゃが麺」がよかった。中毒性あり。こわい