2

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

干杯

4

1 回答 1

4

Following the thread that mzjn linked to, the best solution so far is to first realise a package and a module are equivalent for this question, and that you can use the module python reference, as detailed here on sphinx.

As such, the link to the dessn.examples.simple package can be achieved by simply inserting the code

:py:mod:`dessn.examples.simple`
于 2016-03-28T11:57:41.740 回答