reStructuredText ¶

「reST」などと略されることがある。

参考サイト： http://docs.sphinx-users.jp/rest.html

paragraph ¶

一行以上の空白で区切られたものが段落となる.

「暗黒星！　暗黒星！」

 　遥か天の一方に、怪しき暗黒星が現われたとの信号が、火星世界の天文台から発せられた。

 （出典：黒岩涙香／暗黒星）

「暗黒星！　暗黒星！」

　遥か天の一方に、怪しき暗黒星が現われたとの信号が、火星世界の天文台から発せられた。

（出典：黒岩涙香／暗黒星）

inline markup ¶

いくつかのよく使うインラインマークアップについて。

inline markup（インラインマークアップ）¶
reST	output
強調	強調
強調	強調
``リテラル``	`リテラル`
H :subscript:`2` O	H ₂ O
E = mc :superscript:`2`	E = mc ²
:title-reference:`参考文献`	参考文献

list ¶

list（リスト）¶
reST	output
番号付きリスト A. C言語 a. C++ Java 1. C# #. Visual Basic (1) VB.net 2) Delphi	番号付きリスト C言語 C++ Java C# Visual Basic VB.net Delphi
記号付きリスト * Objective-C - JavaScript + Perl	記号付きリスト Objective-C JavaScript Perl
定義リスト Python オブジェクト指向スクリプト言語。	定義リスト Python オブジェクト指向スクリプト言語。
ラインブロック \| 花間一壺酒 \| 獨酌無相親	ラインブロック花間一壺酒獨酌無相親

（出典：李白／月下獨酌）

code block¶

プレンテキストを表示する。¶

reST
output

::

  朝、鈍い日が照つてて
  　　風がある。
  千の天使が
  　　バスケットボールする。

  　　　　　　中原中也／「宿酔」より抜粋

朝、鈍い日が照つてて
　　風がある。
千の天使が
 　　バスケットボールする。

　　　　　　中原中也／「宿酔」より抜粋

コードブロックを表示する。¶

reST
output

.. code-block:: python

   from turtle import *

   while True:
       forward(200)
       left(170)
       if abs(pos()) < 1:

   input()

from turtle import *

while True:
      forward(200)
      left(170)
      if abs(pos()) < 1:

input()

table ¶

list-table¶

reST

output

.. list-table:: 刀剣男士三条派一覧
   :widths: 5 55 40
   :header-rows: 1
   :stub-columns: 1

   * - No.
     - 名称
     - 刀種
   * - 03
     - 三日月宗近
     - 太刀
   * - 05
     - 小狐丸
     - 太刀
   * - 07
     - 石切丸
     - 大太刀
   * - 09
     - 岩融
     - 薙
   * - 11
     - 今剣
     - 短刀

刀剣男士三条派一覧¶
No.	名称	刀種
03	三日月宗近	太刀
05	小狐丸	太刀
07	石切丸	大太刀
09	岩融	薙
11	今剣	短刀

widths: セルの幅（％）を指定する。
header-rows: ヘッダの行数を指定する。
stub-columns: スタブの行数を指定する。

hyperlink ¶

ハイパーリンクはそのままアドレスを入力すればよい。

http://www.python.jp/

http://www.python.jp/

ターゲットとして埋め込むこともできる。

`python Japan <http://www.python.jp/>`_

python Japan

画像にリンクを張る。画像は buildフォルダ の中に _imagesフォルダ が生成されるので、そこに格納する。

.. image:: _images/twitter_256.png
   :alt: twitter icon
   :target: https://twitter.com/rookumon

section ¶

同種類の記号を並べて見出しを挟む、またはアンダーラインとして引く。

XHTMLでは <h1>見出し１</h1> , <h2>見出し２</h2> となる。

========
section1
========


section2
--------

記号の種類によって区別されるわけではなく、使った順にレベルが設定される。

また、同種の記号を四つ以上並べると水平線になる。

----

****

++++

directives ¶

admonition ¶

警告など¶
reST	output	reST	output
.. attention:: attention	注意 attention	.. caution:: caution	ご用心 caution
.. danger:: danger	危険 danger	..error:: error	エラー error
.. hint:: hint	ヒント hint	.. important:: important	重要 important
.. note:: note	注釈 note	.. tip:: tip	ちなみに tip
.. warning:: warning	警告 warning	.. seealso:: seealso	参考 seealso

image,figure ¶

画像¶
	reST	output
image	.. image:: _imagers/bird.png :width: 60 :alt: bird パラグラフ	パラグラフ
figure	.. figure:: _images/bird.png :scale: 100% :alt: bird キャプション	キャプション

ヒント

image と figure の違いは、キャプションをつけられるかどうか。

画像の位置（右寄せ、左寄せ、センタリング）¶
	reST	output
image	.. image:: _images/bird.png :width: 60 :alt: bird :align: right 画像を右寄せにする。	画像を右寄せにする。
figure	.. figure:: _images/bird.png :scale: 100% :alt: bird キャプション画像を右寄せにする。	キャプション画像を右寄せにする。

ヒント

`` align`` で位置を決められる。 right , center , left が子要素になる。

contents ¶

.. contents:: ローカルな目次

ローカルな目次

reStructuredText
- paragraph
- inline markup
- list
- code block
- table
- hyperlink
- section
- directives
  - admonition
  - image,figure
  - contents
  - sidebar
  - raw
  - meta
  - footnote
  - refarence
  - replace
  - toctree
  - index
  - today

そのページの目次を自動生成する。

sidebar ¶

.. sidebar:: サイドバー
   :subtitle: サイドバーサブタイトル

   ここはサイドバーです。

   画像も入ります。

   .. image:: _images/bird.png
      :width: 60
      :alt: bird

サイドバーは float: right となるので、サイドバーの下に記述した文字はサイドバーの左側へ回り込みます。

テキストを回り込ませたくない場合は、回り込ませたくないテキストの上に

.. raw:: html

   <div style="clear:both;"></div>

などとおまじないをしておくといいかもしれない。

raw ¶

raw¶
reST	output
.. raw:: html <div style=" width:200px; height:40px; color:red; background:black; text-align:center;"> black<br> box</div>	black box

HTMLタグを挿入します。

ちょっとしたstyleの適応など。

meta ¶

メタタグの挿入¶
reST	output
.. meta:: :description: サイトの説明 :keywords: キーワード :description lang=ja: This is description :http-equiv=Content-Type: text/html; charset=utf-8	<meta content="サイトの説明" name="description" /> <meta content="キーワード" name="keywords" /> <meta content="This is description" lang="ja" name="description" /> <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />

Sphinxではデフォルトで

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

が生成されるが、descriptionやkeywordsなどを追加したい場合に。

footnote ¶

脚注¶

reST

output

 Ride a cock-horse

 To Banbury Cross,

 To see what Tommy can buy;

 A penny white loaf, [#f1]_

 A penny white cake, [#f2]_

 And a two-penny apple pie.

.. rubric:: 脚注

.. [#f1] `loaf` は塊のパンのこと。
.. [#f2] バンベリー・ケーキのこと。

   干しブドウや砂糖煮のレモンなどを入れた卵形パイ。

Ride a cock-horse

To Banbury Cross,

To see what Tommy can buy;

A penny white loaf, [1]

A penny white cake, [2]

And a two-penny apple pie.

脚注

[1]	loaf は塊のパンのこと。

[2]	バンベリー・ケーキのこと。干しブドウや砂糖煮のレモンなどを入れた卵形パイ。

rubric はドキュメントのセクションと関係のない見出しを作るときに使います。

refarence ¶

参照

記述に関してはこちらの文章 [Ref]_ を参照のこと。

複数設置することもできる。 [Ref1]_

複数設置の例 [Ref1]_

.. [Ref] 参照するテキスト

.. [Ref1] 参照するテキスト

記述に関してはこちらの文章 [Ref] を参照のこと。

複数設置することもできる。 [Ref1]

複数設置の例 [Ref1]

[Ref]_ から .. [Ref] に飛ぶことができる。

また、セクションを参照するには

:ref:`見出し`

から

.. _見出し:

------
見出し
------

という記述をすればよい。

replace ¶

置換

テキストや画像を置換できます。

.. |name| replace:: ヤン・シュバンクマイエル（Jan Švankmajer）

.. |icon| image:: _images/bird.png
          :alt: bird

|name| はチェコスロバキア・プラハ生まれのシュルレアリストの芸術家、アニメーション作家・映像作家、映画監督です。

|icon| + |icon| |icon| = |icon| |icon| |icon|

ヤン・シュバンクマイエル（Jan Švankmajer）はチェコスロバキア・プラハ生まれのシュルレアリストの芸術家、アニメーション作家・映像作家、映画監督です。

bird + bird bird = bird bird bird

toctree ¶

toctree

.. toctree::
   :maxdepth: 2

   intro
   The_first_chapter
   The_second_chapter

平たく言えば目次を作るということ。

maxdepth で記述する数字は目次のツリーの深さを表す。

masdepth: 2 とあればドキュメントの <h1></h1> , <h2></h2> までを表示する。

サンプルコードの intro , The_first_chapter , The_second_chapter はそれぞれ独立したドキュメントである。

それぞれのドキュメントにある見出しが表示される。

index ¶

索引

.. index::
   single: Young; Don't look back.
   pair: Love; Don't hesitate.
   triple: A man; The strength; The gentleness
   single: 若さ; 振り向かないこと
   pair: 愛; ためらわないこと
   triple: 男; 強さ; 優しさ

索引

作成されたインデックスは索引ページに自動でまとめられる。

索引ページからはインデックスの張られたページへ飛べるので、索引に追加したいワードのあるページにインデックスを張ること。

single は一方通行のワードを記述する。

pair は対になるふたつのワード。

triple はみっつのワード。

today ¶

ビルドした日付を記述する。

|today|

とすると、そのページをビルドした日を生成してくれる。

上書きしてしまうので気を付ける。

このページは |today| にビルドされました。

このページは 2019年02月04日にビルドされました。

[Ref]

参照するテキスト

[Ref1]

(1, 2) 参照するテキスト

Table of Contents

前のトピックへ

次のトピックへ