我一直在寻找关于stackoverflow和官方文档的答案,但仍无法找到解决方案。
在我主要的Sphinx-doc文档中:
Contents:
.. toctree::
views/index.rst
db/index.rst
在views / 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到exacly create_user_db的超链接。
函数不是由autodoc生成的,我不想对db / index中列出的每个函数使用section和* .. _section_label:*。
是否可以使用以下方式链接它:视图可以使用:doc:,:ref:或其他东西将您移动到db / index.html#app.db.create_user_db?
答案 0 :(得分:2)
这应该有效:
this function uses :py:func:`app.db.create_user_db`
您需要使用完全限定名称。