Sphinx ハンズオン

概要

Sphinx は Python 製のドキュメント作成ツールです。本チュートリアルでは Sphinx を使ったドキュメントの作り方をハンズオン形式で学びます。

Sphinx とは

Sphinx はオープンソースのドキュメンテーションツールです。 reST(reStructuredText) という記法で書かれたドキュメントを HTML, ePub, PDF などの複数のドキュメント形式に変換できます。

対象者

  • Sphinx でドキュメントを作成したい方
  • Sphinx を使い始めようとして挫折している方
  • 既に Sphinx を使っているけれど、わからないことがある方
  • ドキュメント作成ツール(Microsoft Word、Microsoft Excel、Wikiクローン)を使っているけど物足りない方

用意するもの

  • Sphinx をインストールした環境(ノートパソコン)
    • OS は Windows, Mac, Linux系 いずれかのうち 使い慣れているもの
    • Python は 2.x 系でも 3.x 系のどちらでも構いません
    • Sphinx は 1.4 以降を推奨します

当日の進め方

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

ハンズオン内容

  • プロジェクトの作成 (sphinx-quickstart)
  • HTML をビルドしてみる(make html)
  • 基礎的なマークアップ(reST, ディレクティブ)を書いてビルドしてみる
    • セクション
    • 箇条書き
    • 太字
    • 斜体
    • リンク
    • code-block
    • テーブル
    • 画像
    • 複数のファイルをリンク(toctree)
  • Markdown を使う際の注意
  • Sphinx リファレンスの読み方
  • わからなくなったときの助けの呼び方

参加者へのお願い

  • 事前に Sphinx のインストールをお願いします。
    • http://sphinx-users.jp/gettingstarted/index.html に手順が掲載されています。
    • わからないことがあった場合、Connpass のコメント欄や Twitter( #sphinxjp タグ付き)などで質問していただけるとサポート可能です。
  • 既に Sphinx を使っている方は、わからないことや困っていることなどをまとめておくと、当日質問しやすいかと思います。

参考資料

募集人数

20人

提供

Sphinxユーザー会

参加申し込み

参加申し込みへ

  • このエントリーをはてなブックマークに追加