TOP

クリップ
2015/10/31(土) 13:00 開催
大阪府 中崎町

Sphinx ワークショップ@関西(2015/10)

基本情報

日 時: 2015/10/31(土) 13:00 〜 17:30
会 場: ECCコンピュータ専門学校 2号館3F 2303教室
住 所: 大阪市北区中崎西2丁目3番35号

イベント内容

主催: 日本UNIXユーザ会

申し込み

イベント概要

  • 日時: 2015/10/31(土) 13時〜17時半
  • 場所: ECCコンピュータ専門学校 2号館3F 2303教室
  • 講師: 清水川(@shimizukawa), 安宅(@kk_Ataka)
  • 会費: jus会員 1,000円, 協力団体会員(Sphinx-Users.jp) 1,000円, 一般 2,000円, 学生 1,000円

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

用意するもの

  • Sphinxをインストールする環境

  • OSはWindows, Mac, Ubuntu いずれか

  • Pythonをインストールしておいてください(Python2でも3でもOK)
  • Sphinx-1.3以降のインストール

当日の進め方

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

タイムテーブル

  • Sphinx概要紹介 30分 ( @shimizukawa)
  • Sphinxデモ30分 (@shimizukawa)
  • Sphinx事例紹介 30分 ( @kk_ataka )
  • 休憩+LT 30分 (LTは募集)
  • ワークショップ 2時間

ワークショップ内容

  • Sphinx のインストール
  • Sphinx-quickstart を実行する
  • ビルドしてみる(HTML)
  • 基礎的なマークアップを書いて変換してみる:セクション、箇条書き、太字、斜体、リンク、code-block、テーブル、画像、複数のファイルをリンク(toctree)
  • Sphinx リファレンスの読み方
  • わからなくなったときの助けの呼び方

対象者

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

参加者へのお願い

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

参考資料

  • Twitterでシェア
  • 0
    Facebookでシェア
  • 0
    Google+でシェア
  • 0
    はてなブックマークに追加

タグに関連するイベント

Facebookページ

dots.で申込可能なイベント