sphinx:python类的内部简短引用

2024-09-28 17:02:59 发布

您现在位置:Python中文网/ 问答频道 /正文

在狮身人面像中我怎么能达到这样的效果呢?在

Creates a `ClassName`_ instance.

.. _ClassName: :class:`~very.long.path.to.ClassName`

为了使我的文档更具可读性,我希望有到长类/方法/etc引用的短链接。在


Tags: topath方法instance文档etclongclass
2条回答

到目前为止,我找到的减少python指令长度的最佳方法是:

.. py:currentmodule:: very.long.path.to.package

This is my :class:`~module_in_package.ClassName`. 

我也遇到了同样的问题,但我最终还是用reSTSubstitutions来解决问题。试试这个:

Creates a |ClassName| instance.

.. |ClassName| replace:: :class:`~very.long.path.to.ClassName`

相关问题 更多 >