Add anchors to cmdline options (#7210)
authorGereon Kremer <nafur42@gmail.com>
Mon, 20 Sep 2021 16:12:57 +0000 (18:12 +0200)
committerGitHub <noreply@github.com>
Mon, 20 Sep 2021 16:12:57 +0000 (09:12 -0700)
This PR adds anchors to the auto-generates command line option documentation. This allows to link to specific options from other parts of the documentation.

src/options/mkoptions.py

index c12a54ebb58f6304f292d41b5d1563a2c47a289c..a8f631de64d09f709f9aa9bd47000a332089a0bf 100644 (file)
@@ -784,6 +784,7 @@ def _sphinx_help_add(module, option, common, others):
             modes[data[0]['name']] = data[0].get('help', '')
 
     data = {
+        'long_name': option.long_name,
         'name': names,
         'help': option.help,
         'expert': option.category == 'expert',
@@ -805,6 +806,8 @@ def _sphinx_help_render_option(res, opt):
     indent = ' ' * 4
     desc = '``{}``'
     val = indent + '{}'
+    res.append('.. _lbl-option-{}:'.format(opt['long_name']))
+    res.append('')
     if opt['expert']:
         res.append('.. admonition:: This option is intended for Experts only!')
         res.append(indent)