Pythonドメイン(py) - nikkie-memos

Pythonドメイン(py)

#SphinxのDomains

https://www.sphinx-doc.org/ja/master/usage/restructuredtext/domains.html#the-python-domain

pyドメインの下にディレクティブとロールがある

ディレクティブ

.. py:function::ディレクティブ

（TODO）conf.pyの設定値add_module_names

https://www.sphinx-doc.org/ja/master/usage/configuration.html#confval-add_module_names

（TODO）詳細情報フィールドのリスト（SphinxのDomains）と関連

.. py:class:: https://www.sphinx-doc.org/ja/master/usage/domains/python.html#directive-py-class

ロール

Pythonオブジェクトのクロスリファレンス

:py:class: