Sphinx的nosearch选项未按预期生效

可能的原因及修复方式 #

• :nosearch: 作用范围限制
  仅在文档顶部添加:nosearch:通常只会排除文档标题本身，不会自动递归排除文档内的类、方法等元素。需要给autoclass指令也追加:nosearch:选项：

  :nosearch:
  
  .. currentmodule:: interactions
  
  HTTP
  ====
  
  .. autoclass:: interactions.api.http.member.MemberRequest
     :members:
     :nosearch:
  

• 检查Sphinx版本兼容性
  部分旧版Sphinx对:nosearch:的支持存在缺陷，建议使用4.0及以上的稳定版本，可通过以下命令查看当前版本：

  sphinx-build --version
  

• 清理旧索引后重新构建
  残留的旧索引文件可能导致修改不生效，执行以下步骤重置构建：

  1. 删除文档构建目录（默认是_build）
  2. 重新运行sphinx-build命令生成文档
  3. 重新生成搜索索引

• 排查conf.py配置干扰
  检查项目的conf.py文件，确保没有通过exclude_patterns或其他搜索相关配置覆盖:nosearch:的作用，同时确认sphinx.ext.intersphinx等扩展未引入外部索引干扰本地搜索结果。

内容的提问来源于stack exchange，提问作者mAxYoLo01