[英]Cross reference documentation of function or class in Sphinx for Python
[英]sphinx: internal short reference to python class
我怎樣才能在獅身人面像中實現這樣的目標?
Creates a `ClassName`_ instance.
.. _ClassName: :class:`~very.long.path.to.ClassName`
我想短鏈接到長類/方法/等參考,以使我的文檔更具可讀性。
到目前為止,我發現減少python引用長度的最好方法是使用當前的模塊指令:
.. py:currentmodule:: very.long.path.to.package
This is my :class:`~module_in_package.ClassName`.
我遇到了同樣的問題,但是我終於可以使用reST Substitutions來工作。 嘗試這個:
Creates a |ClassName| instance.
.. |ClassName| replace:: :class:`~very.long.path.to.ClassName`
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.