Closes #1284: Program options documented with :rst:dir:option can now start with `+`.

CHANGES

@@ -73,11 +73,13 @@ Features added
 * #623: `sphinx.ext.viewcode` supports imported function/class aliases.
 * PR#275: `sphinx.ext.intersphinx` supports multiple target for the
   inventory. Thanks to Brigitta Sipocz.
+* #1284: Program options documented with :rst:dir:`option` can now start with
+  ``+``.
 
 Bugs fixed
 ----------
 
-* #1568: fix a crash when a "centered" directive contains a reference.
+* #1568: Fix a crash when a "centered" directive contains a reference.
 * #1563: :meth:`~sphinx.application.Sphinx.add_search_language` raises
   AssertionError for correct type of argument. Thanks to rikoman.
 * #1174: Fix smart quotes being applied inside roles like :rst:role:`program` or

sphinx/domains/std.py

@@ -28,7 +28,7 @@ from sphinx.util.compat import Directive
 
 
 # RE for option descriptions
-option_desc_re = re.compile(r'((?:/|-|--)?[-_a-zA-Z0-9]+)(\s*.*)')
+option_desc_re = re.compile(r'((?:/|--|-|\+)?[-?@#_a-zA-Z0-9]+)(=?\s*.*)')
 
 
 class GenericObject(ObjectDescription):
@@ -144,8 +144,9 @@ class Cmdoption(ObjectDescription):
                 self.env.warn(
                     self.env.docname,
                     'Malformed option description %r, should '
-                    'look like "opt", "-opt args", "--opt args" or '
+                    'look like "opt", "-opt args", "--opt args", '
-                    '"/opt args"' % potential_option, self.lineno)
+                    '"/opt args" or "+opt args"' % potential_option,
+                    self.lineno)
                 continue
             optname, args = m.groups()
             if count:
@@ -204,30 +205,13 @@ class Program(Directive):
         return []
 
 
-def _split_option(text, refnode, env):
-    try:
-        program, target = re.split(' (?=-|--|/)', text, 1)
-    except ValueError:
-        env.warn_node('Malformed :option: %r, does not contain option '
-                      'marker - or -- or /' % text, refnode)
-        return None, text
-    else:
-        program = ws_re.sub('-', program)
-        return program, target
-
 class OptionXRefRole(XRefRole):
-    innernodeclass = addnodes.literal_emphasis
-
     def process_link(self, env, refnode, has_explicit_title, title, target):
-        program = env.ref_context.get('std:program')
+        # validate content
-        if not has_explicit_title:
+        if not re.match('(.+ )?[-/+]', target):
-            if ' ' in title and not (title.startswith('/') or
+            env.warn_node('Malformed :option: %r, does not contain option '
-                                     title.startswith('-')):
+                          'marker - or -- or / or +' % target, refnode)
-                program, target = _split_option(title, refnode, env)
+        refnode['std:program'] = env.ref_context.get('std:program')
-                target = target.strip()
-        elif ' ' in target:
-            program, target = _split_option(target, refnode, env)
-        refnode['std:program'] = program
         return title, target
 
 
@@ -472,7 +456,7 @@ class StandardDomain(Domain):
         'productionlist': ProductionList,
     }
     roles = {
-        'option':  OptionXRefRole(innernodeclass=addnodes.literal_emphasis),
+        'option':  OptionXRefRole(),
         'envvar':  EnvVarXRefRole(),
         # links to tokens in grammar productions
         'token':   XRefRole(),
@@ -608,13 +592,16 @@ class StandardDomain(Domain):
             return make_refnode(builder, fromdocname, docname,
                                 labelid, contnode)
         elif typ == 'option':
-            if 'std:program' in node:
+            target = target.strip()
-                progname = node['std:program']
+            # most obvious thing: we are a flag option without program
-            elif ' -' in target or ' /' in target:
+            if target.startswith(('-', '/', '+')):
-                # maybe an "any" directive, split it ourselves
+                progname = node.get('std:program')
-                progname, target = _split_option(target, node, env)
             else:
-                progname = None
+                try:
+                    progname, target = re.split(r' (?=-|--|/|\+)', target, 1)
+                except ValueError:
+                    return None
+                progname = ws_re.sub('-', progname.strip())
             docname, labelid = self.data['progoptions'].get((progname, target),
                                                             ('', ''))
             if not docname:

tests/root/objects.txt

@@ -170,6 +170,10 @@ Others
 
 .. cmdoption:: -c
 
+.. option:: +p
+
+Link to :option:`perl +p`.
+
 
 User markup
 ===========