python - 如何从 Sphinx 的默认搜索中排除 RST 文件?

标签 python html python-sphinx restructuredtext

Sphinx 中使用 RST 编写的项目,有没有办法将文件排除在默认搜索功能的考虑范围之外?项目中的一些 RST 文件作为引用包含在内(例如 LICENSE 文件),但在搜索结果中没有用。

是否有配置选项或指令指示 Sphinx 不为包含在搜索结果中的特定 RST 文件编制索引?

最佳答案

如果在 RST 文件的顶部添加 :nosearch:,它将被排除在全文搜索之外。

此功能是在 Sphinx 3.0 中添加的。参见 https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html#special-metadata-fields .

关于python - 如何从 Sphinx 的默认搜索中排除 RST 文件?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/65096267/

相关文章:

javascript - jQuery 在不重置 iframe 的情况下将 DIV 放在前面

documentation-generation - 使用RestructuredText和Sphinx包含预格式化的文件

python - NumPy - 麻烦向量化方法

python - 如何使用带有 gensim 的 TF-IDF 或 LSA 计算单词相似度?

javascript - 如何根据用户屏幕输出不同的图像?

javascript - 一段时间后从文本数组重定向到随机站点

python - Sphinx 代码块中的替换不会被替换

python - 首先用嵌套的列标题创建一个大表,并让 latex 渲染来包装标题文本

javascript - Flask 中的 render_template on JS 点击事件

python - 如何使用 paramiko 连续读取长时间运行的 ssh 命令的输出而不阻塞