Python sphinx Sphinx中automethod的内部超链接
我正在使用Sphinx来记录一个python项目。文档包括API参考和用户指南。我想包括从用户指南到API参考的相关部分的链接,但似乎无法理解 我的API参考使用autodoc扩展;但是,我会单独列出我的方法,例如:Python sphinx Sphinx中automethod的内部超链接,python-sphinx,Python Sphinx,我正在使用Sphinx来记录一个python项目。文档包括API参考和用户指南。我想包括从用户指南到API参考的相关部分的链接,但似乎无法理解 我的API参考使用autodoc扩展;但是,我会单独列出我的方法,例如: .. automodule:: module_name .. autoclass:: class_name .. automethod:: method_a .. automethod:: method_b 在另一个rst文件中,我有
.. automodule:: module_name
.. autoclass:: class_name
.. automethod:: method_a
.. automethod:: method_b
在另一个rst文件中,我有我的用户指南。我可以使用ref链接到另一个rst文件中的任意位置;然而,似乎标签必须在章节标题之前。例如,下面的方法不起作用
userguide.rst
see :ref:`my-reference-label` for more details on method_b
api.rst
.. automodule:: module_name
.. autoclass:: class_name
.. automethod:: method_a
.. _my-reference-label:
.. automethod:: method_b
如何在我的API文档中创建指向特定位置的链接?您不需要定义标签。可以使用
:py:meth:
角色创建指向方法b
的超链接:
:py:meth:`module_name.class_name.method_b`
此标记可以通过各种方式进行自定义和简化(例如,如果是Python,则不需要使用:py
前缀)
详情如下: