Question

使用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-doc插入标签？

干杯

Answer 1

在mzjn链接到的线程之后，到目前为止最好的解决方案是首先实现一个包和一个模块等效于这个问题，并且你可以使用模块python引用，如详细here on sphinx。 / p>

因此，只需插入代码

即可实现dessn.examples.simple包的链接

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

链接到通过Sphinx-apidoc生成的包

1 个答案: