Step Up Sphinx

LastUpdated: $IsoDate$

step 0 まずさわってみよう (Sphinx)

step 0-1. install してみよう

step 0-2. はじめてのプロジェクト作成: sphinx-quickstart

step 0-3. はじめての reSTructuredText: index.rst を眺めてみよう

step 0-4. 出力してみよう

  • make html
  • make txt

step 1. pure text で書いてみよう

step 1-1. 見出しと本文

  • 見出し
  • 本文 (段落)
  • コメント

step 1-2. 構造文

  • リスト
  • ブロック
  • テーブル

step 1-3. 文の修飾

  • 強調
  • ハイパーリンク(インライン)
  • link チェック (make linkcheck)

step 2

a

  • HTML 出力のカスタマイズ
    • conf.py カスタマイズ (共通利用など)
    • Makefile カスタマイズ
      • SPHINXOPTS -w <file>
  • 初めてのマークアップ
    • コメント
    • label
  • 初めてのロール & クロスリファレンス
  • 初めてdirective
    • note/warning
    • table (list-table, csv-table)
    • 画像

step 3

a

  • マークアップしよう
    • footnotes / 脚注
    • citations / 引用
    • ハイパーリンク (マークアップ)
    • substitutions / 置換
  • directive 中級
    • replace
    • include
    • literalinclude
  • index を作ろう
  • todo / todo-list

step X

day X

  • contents
  • glossary
  • only
  • 手順書のためのrole (guilabel / menuselection)
  • 手順書のためのraw::html (チェックボックス)