链接到通过Sphinx apidoc生成的包

Question

使用sphinx-apidoc生成.rst文件时，输出produce不包含任何标签：

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语句，它工作得很好，但是我完全找不到一条语句可以简单地生成一个指向rst文件的超链接。

我是不是遗漏了一些明显的东西，或者我必须找出一种方法来让api-doc插入标签？

干杯

Answer 1

按照mzjn链接到的线程，到目前为止最好的解决方案是首先认识到包和模块对于这个问题是等价的，并且你可以使用模块python参考，如详细的here on sphinx。

因此，可以通过简单地插入代码来实现到dessn.examples.simple包的链接

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