diff --git a/CHANGES b/CHANGES index ea5acc6982f..8c611bbc9a1 100644 --- a/CHANGES +++ b/CHANGES @@ -43,6 +43,7 @@ Features added * #10055: sphinx-build: Create directories when ``-w`` option given * #9993: std domain: Allow to refer an inline target (ex. ``_`target name```) via :rst:role:`ref` role +* #9981: std domain: Strip value part of the option directive from general index * #9391: texinfo: improve variable in ``samp`` role * #9578: texinfo: Add :confval:`texinfo_cross_references` to disable cross references for readability with standalone readers diff --git a/sphinx/domains/std.py b/sphinx/domains/std.py index 82803597de5..e9f75325a33 100644 --- a/sphinx/domains/std.py +++ b/sphinx/domains/std.py @@ -242,7 +242,7 @@ def add_target_and_index(self, firstname: str, sig: str, signode: desc_signature descr = _('%s command line option') % currprogram else: descr = _('command line option') - for option in sig.split(', '): + for option in signode.get('allnames', []): entry = '; '.join([descr, option]) self.indexnode['entries'].append(('pair', entry, signode['ids'][0], '', None)) diff --git a/tests/test_domain_std.py b/tests/test_domain_std.py index 1428bce3177..00e7361a394 100644 --- a/tests/test_domain_std.py +++ b/tests/test_domain_std.py @@ -97,6 +97,9 @@ def test_cmd_option_with_optional_value(app): [desc, ([desc_signature, ([desc_name, '-j'], [desc_addname, '[=N]'])], [desc_content, ()])])) + assert_node(doctree[0], addnodes.index, + entries=[('pair', 'command line option; -j', 'cmdoption-j', '', None)]) + objects = list(app.env.get_domain("std").get_objects()) assert ('-j', '-j', 'cmdoption', 'index', 'cmdoption-j', 1) in objects @@ -355,10 +358,8 @@ def test_multiple_cmdoptions(app): [desc_addname, " directory"])], [desc_content, ()])])) assert_node(doctree[0], addnodes.index, - entries=[('pair', 'cmd command line option; -o directory', - 'cmdoption-cmd-o', '', None), - ('pair', 'cmd command line option; --output directory', - 'cmdoption-cmd-o', '', None)]) + entries=[('pair', 'cmd command line option; -o', 'cmdoption-cmd-o', '', None), + ('pair', 'cmd command line option; --output', 'cmdoption-cmd-o', '', None)]) assert ('cmd', '-o') in domain.progoptions assert ('cmd', '--output') in domain.progoptions assert domain.progoptions[('cmd', '-o')] == ('index', 'cmdoption-cmd-o')