Skip to content

Commit

Permalink
Update doc/source/syntax.rst
Browse files Browse the repository at this point in the history
Co-authored-by: Brian Skinn <brian.skinn@gmail.com>
  • Loading branch information
pawamoy and bskinn committed Aug 31, 2023
1 parent b529d9f commit f387d6e
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion doc/source/syntax.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,8 @@ the string ``zlib`` somewhere within it, but for consistency it should be exactl
``{priority}``
Flag for `placement in search results
<https://github.com/sphinx-doc/sphinx/blob/2f60b44999d7e610d932529784f082fc1c6af989/sphinx/domains/__init__.py#L370-L381>`__. Most will be ``1`` (standard priority) or
``-1`` (omit from results) for documentation built by Sphinx. ``0`` means higher priority, and ``2`` means lower priority.
``-1`` (omit from results) for documentation built by Sphinx;
values of ``0`` (higher priority) or ``2`` (lower priority) may also occur.

To note, as of Jan 2022 this value is **not** used by ``intersphinx``;
it is only used internally within the search function of the static webpages
Expand Down

0 comments on commit f387d6e

Please sign in to comment.