链接到通过Sphinxapid生成的包

2024-06-16 11:29:38 发布

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

使用sphinx apidoc生成.rst文件时,输出产品不包含任何标签:

dessn.examples package
======================

.. automodule:: dessn.examples
    :members:
    :undoc-members:
    :show-inheritance:

Subpackages
-----------

.. toctree::

    dessn.examples.discrete
    dessn.examples.simple

我要做的是从一个定制的主页链接到特定的页面,这个主页不是用apidoc生成的。但是,我找不到任何方法来调用api doc并让它自己生成标签,也无法找到任何正确的方法,在没有标签的情况下直接链接到右.rst,并且不简单地键入我知道将生成的绝对html文件。在

我可以使用::include语句,它工作得很好,但是我完全找不到一个语句,它只会生成到第一个文件的超链接。在

我是不是遗漏了一些显而易见的东西,或者我必须想办法让api文档插入标签?在

干杯


Tags: 文件方法apipackage产品链接sphinx主页
1条回答
网友
1楼 · 发布于 2024-06-16 11:29:38

按照mzjn所链接的线程,到目前为止最好的解决方案是首先实现一个包和一个模块对于这个问题是等价的,并且您可以使用模块python引用,如here on sphinx所示。在

因此,只需插入代码就可以实现到dessn.examples.simple包的链接

:py:mod:`dessn.examples.simple`

相关问题 更多 >