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

Update documentation for the `:no-search:` file-wide metadata option

Browse Source
This commit is contained in:
Adam Turner
2025-01-10 16:56:21 +00:00
parent 404e4ffbed
commit fdb1b0cdad
1 changed files with 17 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
doc/usage/restructuredtext/field-lists.rst
View File

@@ -68,11 +68,24 @@ At the moment, these metadata fields are recognized:
.. versionadded:: 1.0
``nosearch``
If set, full text search for this file is disabled. ::
``no-search``
Disable full text search for this document.
:nosearch:
.. code-block:: rst
.. note:: object search is still available even if ``nosearch`` option is set.
:no-search:
.. note::
The ``:no-search:`` option only disables full text search,
meaning that object search will still be available even if
``:no-search:`` is set.
.. versionadded:: 3.0
.. versionchanged:: 7.3
The file-wide metadata option ``:nosearch:`` was renamed
to ``:no-search:``.
The previous name has been retained as an alias,
but will be deprecated and removed
in a future version of Sphinx.