[Sphinx] #2 入門編 (メモ書きからはじめる)

前提条件

• Sphinxの利用環境が準備できていること
  • 参考: http://qiita.com/tcsh/items/ce758fd45f748463c4b9#%E7%92%B0%E5%A2%83%E6%A7%8B%E7%AF%89-%E5%8F%82%E8%80%83
• ドキュメントプロジェクトを作成してあること
  • http://qiita.com/tcsh/items/b102d70212d97aede46f

1. 事前作業
   ===========

0.1. プロジェクトディレクトリの決定

変数の設定

DIR_HANDSON="${HOME}/$( date +%Y%m%d )-handson" \
     && echo ${DIR_HANDSON}

0.2. プロジェクトディレクトリへの移動

コマンド

cd ${DIR_HANDSON}/main/

1. 編集対象ファイルの決定
   =========================

変数の設定

FILE_HANDSON="${DIR_HANDSON}/main/index.rst" \
     && echo ${FILE_HANDSON}

1. 見出し
   =========

見出しは必須です。

文字列の次の行に同じ記号が連続しているとそれが見出しだと認識されます。

• 任意で文字列の上にも同じ記号を連続して記述することができます。

  • (次行と同じ長さである必要があります。)

• 記号の連続は、見出し文字より長い必要があります。

コマンド

cat << EOF > ${FILE_HANDSON}
================================================================
ハンズオンサンプル
================================================================

----------------------------------------------------------------
基本的なマークアップ
----------------------------------------------------------------

EOF

コマンド(更新)

echo '---(ここから)---' \
     && cat ${FILE_HANDSON} \
     && echo '---(ここまで)---'
make html

1. 本文
   =======

コマンド

cat << EOF >> ${FILE_HANDSON}
いくつかSphinxのサンプルを記述していきます。
まずは基本的なマークアップから。
EOF

コマンド(更新)

echo '---(ここから)---' \
     && cat ${FILE_HANDSON} \
     && echo '---(ここまで)---'
make html

1. リスト (バレット、数字付き、定義)
   ====================================

コマンド

cat << EOF >> ${FILE_HANDSON}

- リストA
- リストB

  - リストB.a

- リストC

EOF

コマンド(更新)

echo '---(ここから)---' \
     && cat ${FILE_HANDSON} \
     && echo '---(ここまで)---'
make html

コマンド

cat << EOF >> ${FILE_HANDSON}

2. 2番目から初めてもよい。
3. 3番目です。

  3.1. 枝番

4. 4番目です。

EOF

コマンド(更新)

echo '---(ここから)---' \
     && cat ${FILE_HANDSON} \
     && echo '---(ここまで)---'
make html

コマンド

cat << EOF >> ${FILE_HANDSON}

AWS
  Amazonが提供しているクラウドコンピューティングサービス

EC2
  Elastic Cloud Computingの略

EOF

コマンド(更新)

echo '---(ここから)---' \
     && cat ${FILE_HANDSON} \
     && echo '---(ここまで)---'
make html

コマンド

cat << EOF >> ${FILE_HANDSON}

:日時: 2015-07-20 13:00 - 14:00
:場所: 茅場町
:参加者: Hatano

EOF

コマンド(更新)

echo '---(ここから)---' \
     && cat ${FILE_HANDSON} \
     && echo '---(ここまで)---'
make html

1. リテラルブロック
   ===================

コマンド

cat << EOF >> ${FILE_HANDSON}

コマンド::

  ls -a ~

結果(例)::

  .exrc

EOF

コマンド(更新)

echo '---(ここから)---' \
     && cat ${FILE_HANDSON} \
     && echo '---(ここまで)---'
make html

1. リンク
   =========

コマンド

echo 'URLは、http://python.org です。' >> ${FILE_HANDSON}
echo 'これは `リンク付きテキスト <http://python.org>`_ です。' >> ${FILE_HANDSON}

echo '---(ここから)---' \
     && cat ${FILE_HANDSON} \
     && echo '---(ここまで)---'
make html

1. テーブル、インラインマークアップ
   ===================================

6.1. テーブル

コマンド

cat << EOF >> ${FILE_HANDSON}

+---------------------+
|栃木県内の勉強会     |
+========+============+
|宇都宮  |集合知勉強会|
+        +------------+
|        |Objective-C |
+--------+------------+
|西那須野|とちぎRuby  |
+--------+------------+

EOF

コマンド(更新)

echo '---(ここから)---' \
     && cat ${FILE_HANDSON} \
     && echo '---(ここまで)---'
make html

6.2. インラインマークアップ

コマンド

cat << EOF >> ${FILE_HANDSON}

これは\ **太字**\ です。

これは\ *斜体*\ です。

これは\*です。

これは\ ``<b>リテラル</b>``\ です。

EOF

コマンド(更新)

echo '---(ここから)---' \
     && cat ${FILE_HANDSON} \
     && echo '---(ここまで)---'
make html

完了