経緯
自分自身がSphinxでよく使うもので、少し調べないと出てこないものをまとめました。
外部のcsvファイルを読み込む
.. csv-table:: サンプルデータ
:file: sample.csv
:encoding: utf-8
:header-rows: 1
(一行あける)
sample.csvは、Excelで「名前をつけて保存」からファイル形成を「CSV UTF-8(コンマ区切り)(.csv)」で選択して、保存します。最後は、:header-rowsの後、一行開けないと、表示されません。またcsvファイルは、プログラムファイルと同じディレクトリに入れます。
左がExcel画像、右がHTML画像
同じページ内のラベル参照
.. _`foo_label`:
===============
foo Methods
....
....
....
=============
ページ先頭の方にある :ref:`foo 説明<foo_label>` を参照。
これも、[.. _foo_label:]の次の行は開けておきましょう。
コンストラクタをドキュメントに追加する方法
デフォルトでは、コンストラクタはドキュメントに追加されないです。
conf.pyにて下記の通りに追記しましょう。
def skip(app, what, name, obj, would_skip, options):
if name == "__init__":
return False
return would_skip
def setup(app):
app.connect("autodoc-skip-member", skip)
すると、コンストラクタはスキップされません。
参照
Sphinxのautodocを使用して、クラスの__init __（self）メソッドを文書化する方法は？
1. restructured text の練習