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

Sam*_*eay 5 python restructuredtext hyperlink python-sphinx api-doc

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

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

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

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

.. toctree::

    dessn.examples.discrete
    dessn.examples.simple
Run Code Online (Sandbox Code Playgroud)

我想做的是从自定义主页链接到特定页面,该主页不是使用 apidoc 生成的。但是,我找不到任何方法来调用 api-doc 并让它自己生成标签,我也无法找出任何正确的方法来简单地链接到.rst没有标签的右侧,并且不需要简单地键入我知道会的绝对 html 文件产生。

我可以使用该::include语句,并且它工作得很好,但我完全找不到一个可以简单地生成指向第一个文件的超链接的语句。

我是否在这里遗漏了一些明显的东西,或者我是否必须找到一种方法来使 api-doc 插入标签?

干杯

Sam*_*eay 8

按照 mzjn 链接到的线程,迄今为止最好的解决方案是首先实现一个包和一个模块对于这个问题是等效的,并且您可以使用模块 python 参考,如sphinx 上的详细信息。

这样,dessn.examples.simple只需插入代码即可实现包的链接

:py:mod:`dessn.examples.simple`
Run Code Online (Sandbox Code Playgroud)