通过Sphinx-apidoc生成的包如何进行链接

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

我是否漏掉了什么明显的东西，或者我必须想出一种方法让 api-doc 插入标签？

谢谢

- Samreay

---

也许您可以使用:py:mod:交叉引用角色。另请参见https://dev59.com/u2Eh5IYBdhLWcg3wMA7M#22714510。 - mzjn

那正是我想要的。我一直在寻找“package”这个单词，以至于“module”直接跳过了我的脑海。谢谢！ - Samreay

Answer 1

跟随mzjn提供的线索，目前最好的解决方案是首先意识到对于这个问题，包和模块是等价的，并且可以使用详细介绍在sphinx上的Python参考文档。

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

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

- Samreay

---

谢谢你的分享。我现在正在查看cross-referencing python。 - undefined