python - 如何使用 sphinx autodoc 阻止 "Index"和 "Python Module Index"出现?

标签 python python-sphinx autodoc

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

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

如果我将 :noindex: 添加到每个 autoclassautomodule 中,我只能禁用此页面。

问题: 有没有办法将 :noindex 全局插入到这些重构文本指令中?


我的index.rst供引用:

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

   README
   CHANGELOG
   DEV-README

最佳答案

您应该能够在index.rst下删除它。看看是否有一行:

* :ref:`modindex`

关于python - 如何使用 sphinx autodoc 阻止 "Index"和 "Python Module Index"出现?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/48086587/

相关文章:

python - 以编程方式使用特定于 Sphinx 的指令解析 .rst 文件

django - 如何查看 Django 中生成的 HTML Sphinx?

php - 用于为 Swagger-UI 生成 JSON 文件的 Swagger-PHP

python - sphinx-build 失败 - autodoc 无法导入/查找模块

python - 如何使用多个参数正确格式化 Python Print?

带有 Sphinx 生成的文档的 Github 页面无法正确显示 HTML

python - KDB+/q :What is a canonical implementation of a remote query?

python-sphinx - 使用 Sphinx 的 Autodoc 仅显示私有(private)方法

python - Discord.py - 使用特定消息回复 DM

python - Jupyter笔记本空闲锁定 Redshift 表