如何从目录树中排除 autodoc 对象?

问题描述 投票:0回答:1

我们在一个文件中多次使用

autoclass
指令,但这些指令出现在 TOC 树中是没有意义的。

但是,在其他文件中,autodoc 对象显示在目录树中确实有意义。

有没有办法在每个文件或每个 autodoc 的基础上从

toctree
中排除 autodoc 对象?

python-sphinx autodoc
1个回答
0
投票

好吧,看来

:no-index:
选项可以做到这一点。无法轻松地从文档中找出其用途。

.. autoclass:: foo.bar.MyClass
   :no-index:
© www.soinside.com 2019 - 2024. All rights reserved.