IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

changes entry, test

Browse Source
This commit is contained in:
William Lachance 2025-02-11 23:04:34 -05:00
parent b2fa4633a2
commit 4ca3afeb58
3 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES.rst
View File

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

4
tests/roots/test-search/index.rst
View File

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

5
tests/test_search.py
View File

@ -396,10 +396,13 @@ def test_nosearch(app):
app.build() app.build()
index = load_searchindex(app.outdir / 'searchindex.js') index = load_searchindex(app.outdir / 'searchindex.js')
assert index['docnames'] == ['index', 'nosearch', 'tocitem'] assert index['docnames'] == ['index', 'nosearch', 'tocitem']
# latex is in 'nosearch.rst', and nowhere else
assert 'latex' not in index['terms'] 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 # bat is indexed from 'index.rst' and 'tocitem.rst' (document IDs 0, 2), and
# not from 'nosearch.rst' (document ID 1) # not from 'nosearch.rst' (document ID 1)
assert 'bat' in index['terms']
assert index['terms']['bat'] == [0, 2] assert index['terms']['bat'] == [0, 2]