changes entry, test

CHANGES.rst

@@ -36,6 +36,8 @@ Features added
 * #13146: Napoleon: Unify the type preprocessing logic to allow
   Google-style docstrings to use the optional and default keywords.
   Patch by Chris Barrick.
+* #11280: Add ability to skip a particular section using the `no-search` class.
+  Patch by Will Lachance.
 
 Bugs fixed
 ----------

tests/roots/test-search/index.rst

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

tests/test_search.py

@@ -396,10 +396,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]