読者です 読者をやめる 読者になる 読者になる

雑記

インフラのことだったりプログラムのことだったりどうでもいいこと書いたり。要は雑記。

sphinxの基本的な記法メモ

sphinxって?

python製のドキュメンテーションビルダー。
何でも開発者が使うと幸せになれるとかなれないとか。

というわけで

使ってみてるけどなかなかいい感じ。
viで書けたりgitとかでバージョン管理出来るのがよいですね。
ただhtmlをプレビューで見れないのがちょっと不満なところかな?

では以下より本題。
記法をよく忘れるのでまとめとく。

基本記法

タイトル

========
タイトル
========

※「===」はタイトルより長くしないとmakeの特にwarningでます。

サブタイトル

サブタイトル
=============

※「===」はサブタイトルより長くしないとmakeの特にwarningでます。

サブタイトルをもういっこ下の段落に

サブサブタイトル
----------------

※「---」はサブサブタイトルより(ry

太字

**太字**

斜体

*斜体*

リンク付きテキスト

`テキスト <http://www.google.co.jp/>`_

リスト

ul的な。

* hoge
* fuga
* piyo

数字付きリスト

ol的な。

#. hoge
#. fuga
#. piyo

段落リスト

dl的な

hoge
hogehoge
fuga
fugafuga
piyo
piyopiyo

注釈

.. note::
注釈だよ

警告

.. warning::
警告だよ

改行

hoge

fuga

文字間に空行を入れる必要がある。

章に番号を付けたい

.. toctree::
:numbered:

hoge
fuga
piyo

「:numbered」を付けると、自動的に以下のように番号が振られる
1. hoge
2. fuga
3. piyo

ちなみに、各コンテンツ配下のコンテンツに対しても自動的に番号が振られます。



ここに書いたのはほんと基本。
もっと使いこなしてみたいな。