python - 文件之间的 Sphinx 链接函数

Question

我一直在寻找关于 stackoverflow 和官方文档的答案，但仍然找不到解决方案。

在主要的 Sphinx-doc 文档中，我有：

Contents:

.. toctree::

    views/index.rst
    db/index.rst

在视图/index.rst

.. py:currentmodule:: app.views
.. py:function:: create_user

  this function uses create_user_db

并在 db/index.rst

.. py:currentmodule:: app.db

.. py:function:: create_user_db
   this function creates the user in database

我需要的是从 create_user 到 create_user_db 所在位置的超链接。

函数不是由 autodoc 生成的，我不想为 db/index 中列出的每个函数使用 section 和 *.. _section_label :*。

是否可以使用 :doc:、:ref: 或其他方式将视图链接到 db/index.html#app.db.create_user_db ？

Answer 1

这应该有效：

this function uses :py:func:`app.db.create_user_db`

您需要使用完全限定名称。