# Sphinx

## sphinxでのtableのかきかた
- eval_rstつけてかこむとrstで解釈してくれる．
````
```eval_rst
  hoge
```
````

- Grid Table
```
+----------+----------+----------+
| Header 1 | Header 2 | Header 3 |
+==========+==========+==========+
| | Item 1 |          |          |
| | Item 2 |          |          |
+----------+----------+----------+
```
- Simple Table
```
======== ======== ========
Header 1 Header 2 Header 3
-------- -------- --------
Item 1   | Item 2
         | Item 3
======== ======== ========
```
- list-table
"|" の位置を合わせることが重要
```
.. list-table:: TheListTable
    :header-rows: 1
    :widths: 10, 10, 10

    * - Header 1
      - Header 2
      - Header 3
    * - | Item1
        | Item2
      - Item3
      - Item4
    * - Item5
      - Item6
      - Item7
```
改段落を利用
```
.. list-table:: TheListTable
    :header-rows: 1
    :widths: 10, 10, 10

    * - Header 1
      - Header 2
      - Header 3
    * - Item1

        Item2
      -
      -
```
- csv-table
```
.. csv-table:: TheCsvTable
    :header: Header 1, Header 2, Header 3
    :widths: 10, 10, 10
    
    "| Item 1
    | Item 2",Item 3,Item 4
```
- ref.) [restructuredText の表のセルの中で改行する - サポンテ 勉強ノート](http://saponote.hatenablog.com/entry/2017/11/24/214309)

## images
````
```eval_rst
.. image:: ../img/sphinx.png
   :scale: 40%
   :height: 100px
   :width: 200px
   :align: left
```
````

- 例
```eval_rst
.. image:: ../resources/images/kaminoku.png
```
```eval_rst
.. image:: ../resources/images/simonoku.png
```

キャプションつけたいときはfigureが便利（なはず？）
````
```eval_rst
.. figure:: ファイル名
   :scale: 40%
   :alt: Alternate Text (キャプションじゃないよ)

   一行あけてここに書いたものがキャプションになります。
```
````
- [図にキャプションをつけたい — Python製ドキュメンテーションビルダー、Sphinxの日本ユーザ会](https://sphinx-users.jp/reverse-dict/images/caption.html)
  - ただしcssかいておかないと意味なさそう...