mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
merge
This commit is contained in:
commit
ae234c3ded
3
CHANGES
3
CHANGES
@ -76,6 +76,9 @@ Bugs fixed
|
|||||||
versions for Python 2 and 3, and loading the appropriate version for the
|
versions for Python 2 and 3, and loading the appropriate version for the
|
||||||
running Python version.
|
running Python version.
|
||||||
|
|
||||||
|
* #1017: Be helpful and tell the user when the argument to :rst:dir:`option`
|
||||||
|
does not match the required format.
|
||||||
|
|
||||||
Documentation
|
Documentation
|
||||||
-------------
|
-------------
|
||||||
|
|
||||||
|
@ -27,8 +27,7 @@ from sphinx.util.compat import Directive
|
|||||||
|
|
||||||
|
|
||||||
# RE for option descriptions
|
# RE for option descriptions
|
||||||
option_desc_re = re.compile(
|
option_desc_re = re.compile(r'((?:/|-|--)[-_a-zA-Z0-9]+)(\s*.*)')
|
||||||
r'((?:/|-|--)[-_a-zA-Z0-9]+)(\s*.*?)(?=,\s+(?:/|-|--)|$)')
|
|
||||||
|
|
||||||
|
|
||||||
class GenericObject(ObjectDescription):
|
class GenericObject(ObjectDescription):
|
||||||
@ -130,14 +129,23 @@ class Target(Directive):
|
|||||||
|
|
||||||
class Cmdoption(ObjectDescription):
|
class Cmdoption(ObjectDescription):
|
||||||
"""
|
"""
|
||||||
Description of a command-line option (.. cmdoption).
|
Description of a command-line option (.. option).
|
||||||
"""
|
"""
|
||||||
|
|
||||||
def handle_signature(self, sig, signode):
|
def handle_signature(self, sig, signode):
|
||||||
"""Transform an option description into RST nodes."""
|
"""Transform an option description into RST nodes."""
|
||||||
count = 0
|
count = 0
|
||||||
firstname = ''
|
firstname = ''
|
||||||
for m in option_desc_re.finditer(sig):
|
for potential_option in sig.split(', '):
|
||||||
|
potential_option = potential_option.strip()
|
||||||
|
m = option_desc_re.match(potential_option)
|
||||||
|
if not m:
|
||||||
|
self.env.warn(
|
||||||
|
self.env.docname,
|
||||||
|
'Malformed option description %r, should '
|
||||||
|
'look like "-opt args", "--opt args" or '
|
||||||
|
'"/opt args"' % potential_option, self.lineno)
|
||||||
|
continue
|
||||||
optname, args = m.groups()
|
optname, args = m.groups()
|
||||||
if count:
|
if count:
|
||||||
signode += addnodes.desc_addname(', ', ', ')
|
signode += addnodes.desc_addname(', ', ', ')
|
||||||
|
@ -89,6 +89,7 @@ div.sphinxsidebar #searchbox input[type="submit"] {
|
|||||||
|
|
||||||
img {
|
img {
|
||||||
border: 0;
|
border: 0;
|
||||||
|
max-width: 100%;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* -- search page ----------------------------------------------------------- */
|
/* -- search page ----------------------------------------------------------- */
|
||||||
|
@ -92,6 +92,7 @@ div.sphinxsidebar input {
|
|||||||
|
|
||||||
img {
|
img {
|
||||||
border: 0;
|
border: 0;
|
||||||
|
max-width: 100%;
|
||||||
}
|
}
|
||||||
|
|
||||||
/* -- search page ----------------------------------------------------------- */
|
/* -- search page ----------------------------------------------------------- */
|
||||||
|
Loading…
Reference in New Issue
Block a user