如何使用 sphinx autodoc 阻止“索引”和“Python 模块索引”出现？答案

【问题标题】：How do I stop the "Index" and "Python Module Index" from appearing using sphinx autodoc?如何使用 sphinx autodoc 阻止“索引”和“Python 模块索引”出现？
【发布时间】：2018-01-03 23:26:22
【问题描述】：

我正在使用 sphinx autodoc 来检索类和模块文档字符串。

当我使用 autodoc sphinx 时，会自动生成一个名为 Python Module Index 的丑陋页面。

如果我将:noindex: 添加到每个autoclass 和automodule，我只能禁用此页面。

问题： 有没有办法将:noindex 全局插入到这些 ReStructured Text 指令中？

我的index.rst供参考：

.. toctree::
   :maxdepth: 5
   :glob:

   README
   CHANGELOG
   DEV-README

【问题讨论】：

标签： python python-sphinx autodoc

【解决方案1】：

您应该可以在 index.rst 下删除它。看看有没有一行：

* :ref:`modindex`

【讨论】：

模块索引不再出现。我认为这是一个单独的 sphinx 项目中的 docs/_build/doctrees 中的 :ref:modindex 的缓存问题。