Sphinx-Users.jp の清水川さんと安宅さんを講師にお迎えして、Sphinxを使ったドキュメント作成のワークショップを行います。

ワークショップについて

オープンソースのドキュメンテーションツール、Sphinxを用いたドキュメント作成について紹介します。Sphinxは文章を構造化しやすいため、分かりやすく、美しいドキュメントを簡単に作ることが出来ます。SphinxはHTML, ePub, PDFなどの複数のドキュメント形式を出力し、ドキュメントはreStructuredText(reST)記法で記載します。 「触ってみようと逡巡している人」や「使おうと思ったけどよく分からない」といった方を対象に、基本的な文法、ビルド、についてハンズオン形式で学んでいきます。

開催概要

• 日時: 2015/10/31(土) 13時〜17時30分（12時30分受付開始）
• 場所: ECCコンピュータ専門学校 2号館3F 2303教室
• 交通:
  • JR大阪駅・御堂筋口より徒歩約10分
  • 阪急梅田駅・茶屋町口より徒歩約10分
  • 阪神梅田駅・東出口より徒歩約10分
• 講師: 清水川(@shimizukawa), 安宅(@kk_Ataka)

対象者

• Sphinxでドキュメントを作成したい方。
• ドキュメントを楽しく作りたい方。
• 既にSphinxを使っているけれど、わからないことがある方
• ロジカルなドキュメントを書きたい方

参加される方は以下をご用意ください

• SphinxがインストールされたノートPC
  • OSはWindows, Mac, Ubuntu いずれか
    • それ以外の環境でも構いませんが、環境面ではまってもサポートできません
  • Pythonをインストールしておいてください（Python2でも3でもOK）
  • Sphinx-1.3以降のインストール
• LANケーブル（ネット接続が必要な方のみ）

当日の進め方

• 講師が研修資料を用意し、プロジェクターに研修資料を映しながら説明していきます。
• 各自手元のPCで入力し実行結果を確認します。 質問は随時回答致します。

タイムテーブル

時間	内容
13:00 - 13:10	前説
13:10 - 13:40	Sphinx概要紹介 30分 ( @shimizukawa)
13:40 - 14:10	Sphinxデモ30分 (@shimizukawa)
14:10 - 14:20	休憩
14:20 - 14:50	Sphinx事例紹介 30分 ( @kk_ataka )
14:50 - 15:50	ワークショップ前半
15:50 - 16:00	休憩
16:00 - 17:00	ワークショップ後半
17:00 - 17:05	休憩（LT準備）
17:05 - 17:20	LT（3本程度）
17:20 - 17:30	振り返り、クロージング

参加者される方へのお願い

• 事前に Sphinx のインストールをお願いします。
• インストール方法は http://sphinx-users.jp/gettingstarted/index.html に掲載されています。
• インストールをしていない方向けの説明も行いますが、インストールが済んでいるとハンズオンで実践できる内容が多くなります。
• 既にSphinxを使っている方は、わからないことや困っていることなどをまとめておくと、当日質問しやすいかと思います。

懇親会

有志で懇親会を予定しています。
お時間のある方は是非ご参加ください。

参考資料

• Sphinx をはじめよう (Sphinx-users.jp)
• オープンソースカンファレンス 2013 Tokyo/Spring の際のハンズオン資料