Sphinx文件之间的链接功能

Question

我一直在stackoverflow和官方文档中寻找答案，但还是找不到解决方案。

在Sphinx-doc主文档中，我有。

Contents:

.. toctree::

    views/index.rst
    db/index.rst

在viewsindex.rst中

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

  this function uses create_user_db

而在dbindex.rst中

.. py:currentmodule:: app.db

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

我需要的是一个超链接，从create_user到create_user_db的确切位置。

函数不是由autodoc生成的，我不想为dbindex中列出的每个函数使用section和*. _section_label :*来处理dbindex中列出的每个函数。

是否可以这样链接，让视图可以使用 :doc:, :ref:或其他方式将你移动到dbindex.html#app.db.create_user_db?

Answer 1

这应该可以工作。

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

你需要使用完全限定的名称。