データテンプレートしたい(sphinxcontrib.datatemplates
)
$ pip3 install sphinxcontrib.datatemplates
1extensions = [
2 "sphinxcontrib.datatemplates"
3 ]
CSVなどのデータを、Jinjaテンプレート構文で表示できます。
CSVを読み込みたい(datatemplate:csv
)
1:::{datatemplate:csv} ファイル名
2---
3template: テンプレート名.tmpl
4headers: true / false
5dialect: auto / excel / excel-tab / unix
6---
7
8テンプレート構文
9
10:::
CSVデータを表示するテンプレートは、ディレクティブの本文にJinja構文で定義します。
複数のCSVデータをそれぞれ読み込んで表示する場合、テンプレート構文を外部ファイルにすると便利です。
その場合、conf.py
で定義したtemplate_path
(デフォルトだと_templates
)にファイルを配置し、template
オプションで外部ファイルを指定します。
headers
オプションを使うと、データをリスト型で読み込むか、辞書型で読みこむか切り替えることができます。
デフォルトはfalse
(=リスト型)です。
dialect
はexcel
/ excel-tab
/ unix
から選べます。
詳しくは、CSVを読み込む際に使っているcsvモジュールのDialectクラスを参照してください。