Skip to content

Commit

Permalink
Update documentation for the :no-search: file-wide metadata option
Browse files Browse the repository at this point in the history
  • Loading branch information
AA-Turner committed Jan 10, 2025
1 parent 404e4ff commit fdb1b0c
Showing 1 changed file with 17 additions and 4 deletions.
21 changes: 17 additions & 4 deletions doc/usage/restructuredtext/field-lists.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit fdb1b0c

Please sign in to comment.