Add :noindexentry: option

[jakobandersen]

Add the :noindexentry: option to the built-in domains and update+refactor the documentation to better describe what :noindex: and :noindexentry: does.

Feature or Bugfix

• Feature
• Refactoring

Purpose

See the discussion in #7052

Detail

Fixes #7052

The following rst shows the effect:

.. cpp:function:: void f()
.. cpp:function:: void g()
	:noindexentry:

.. c:function:: void f()
.. c:function:: void g()
	:noindexentry:

.. py:function:: f()
.. py:function:: g()
	:noindexentry:

.. py:class:: F
.. py:class:: G
	:noindexentry:

.. js:function:: f()
.. js:function:: g()
	:noindexentry:

[jakobandersen]

(Is there a good way to make the example into a test?)

[tk0miya]

LGTM. It would be very nice if "versionadded" definition in docs!

[tk0miya]

(Is there a good way to make the example into a test?)

For example, tests/test_domain_py.py contains some examples for checking index entries.

sphinx/tests/test_domain_py.py

Lines 490 to 495 in 0c0da9b

	assert_node(doctree[0], addnodes.index,
	entries=[('pair', 'built-in function; func1()', 'func1', '', None)])
	assert_node(doctree[3], addnodes.index,
	entries=[('pair', 'module; example', 'module-example', '', None)])
	assert_node(doctree[4], addnodes.index,
	entries=[('single', 'func2() (in module example)', 'example.func2', '', None)])

[jakobandersen]

LGTM. It would be very nice if "versionadded" definition in docs!

Ups, indeed, should be there now.

For example, tests/test_domain_py.py contains some examples for checking index entries.

Thanks! The affected domains should have tests along this line now.

[tk0miya]

LGTM with nits. There are some TAB chars. Could you expand them all?