Add ability to "skip" adding marked documentation to the search index (#11280)

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
This commit is contained in:
Will Lachance
2025-02-12 11:47:14 -05:00
committed by GitHub
parent 94563a398b
commit bb68e72333
4 changed files with 16 additions and 1 deletions

View File

@@ -17,6 +17,10 @@ textinheading
International
.. tip::
:class: no-search
bat cat
.. toctree::
tocitem

View File

@@ -398,10 +398,13 @@ def test_nosearch(app):
app.build()
index = load_searchindex(app.outdir / 'searchindex.js')
assert index['docnames'] == ['index', 'nosearch', 'tocitem']
# latex is in 'nosearch.rst', and nowhere else
assert 'latex' not in index['terms']
assert 'bat' in index['terms']
# cat is in 'index.rst' but is marked with the 'no-search' class
assert 'cat' not in index['terms']
# bat is indexed from 'index.rst' and 'tocitem.rst' (document IDs 0, 2), and
# not from 'nosearch.rst' (document ID 1)
assert 'bat' in index['terms']
assert index['terms']['bat'] == [0, 2]