gpt4 book ai didi

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

转载 作者:行者123 更新时间:2023-12-01 04:02:27 26 4
gpt4 key购买 nike

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

干杯

最佳答案

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

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

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

关于python - 链接到通过 Sphinx-apidoc 生成的包,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/36247303/

26 4 0
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com