mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
* Support for C class names (and const specifiers).
* Fix handling of describe environment.
This commit is contained in:
parent
e1e999bdb0
commit
3761223d85
3
CHANGES
3
CHANGES
@ -30,6 +30,9 @@ New features added
|
||||
* A new config value, `autoclass_content`, selects if the docstring of the
|
||||
class' ``__init__`` method is added to the directive's body.
|
||||
|
||||
* Support for C++ class names (in the style ``Class::Function``) in C function
|
||||
descriptions.
|
||||
|
||||
Bugs fixed
|
||||
----------
|
||||
|
||||
|
@ -16,6 +16,16 @@ directory`, the extension is stripped, and path separators are converted to
|
||||
slashes. All values, parameters and suchlike referring to "documents" expect
|
||||
such a document name.
|
||||
|
||||
.. cfunction:: Class::method(int bla, int foo) const
|
||||
|
||||
pass
|
||||
|
||||
.. cmdoption:: --longopt <arg>
|
||||
|
||||
.. class:: Test
|
||||
|
||||
.. method:: X
|
||||
|
||||
|
||||
The TOC tree
|
||||
------------
|
||||
|
@ -154,12 +154,14 @@ def parse_py_signature(signode, sig, desctype, env):
|
||||
c_sig_re = re.compile(
|
||||
r'''^([^(]*?) # return type
|
||||
([\w:]+) \s* # thing name (colon allowed for C++ class names)
|
||||
(?: \((.*)\) )? $ # optionally arguments
|
||||
(?: \((.*)\) )? # optionally arguments
|
||||
(\s+const)? $ # const specifier
|
||||
''', re.VERBOSE)
|
||||
c_funcptr_sig_re = re.compile(
|
||||
r'''^([^(]+?) # return type
|
||||
(\( [^()]+ \)) \s* # name in parentheses
|
||||
\( (.*) \) $ # arguments
|
||||
\( (.*) \) # arguments
|
||||
(\s+const)? $ # const specifier
|
||||
''', re.VERBOSE)
|
||||
c_funcptr_name_re = re.compile(r'^\(\s*\*\s*(.*?)\s*\)$')
|
||||
|
||||
@ -190,10 +192,17 @@ def parse_c_signature(signode, sig, desctype):
|
||||
m = c_sig_re.match(sig)
|
||||
if m is None:
|
||||
raise ValueError('no match')
|
||||
rettype, name, arglist = m.groups()
|
||||
rettype, name, arglist, const = m.groups()
|
||||
|
||||
signode += addnodes.desc_type("", "")
|
||||
parse_c_type(signode[-1], rettype)
|
||||
try:
|
||||
classname, funcname = name.split('::', 1)
|
||||
classname += '::'
|
||||
signode += addnodes.desc_classname(classname, classname)
|
||||
signode += addnodes.desc_name(funcname, funcname)
|
||||
# name (the full name) is still both parts
|
||||
except ValueError:
|
||||
signode += addnodes.desc_name(name, name)
|
||||
# clean up parentheses from canonical name
|
||||
m = c_funcptr_name_re.match(name)
|
||||
@ -222,6 +231,8 @@ def parse_c_signature(signode, sig, desctype):
|
||||
param += nodes.emphasis(' '+argname, ' '+argname)
|
||||
paramlist += param
|
||||
signode += paramlist
|
||||
if const:
|
||||
signode += addnodes.desc_classname(const, const)
|
||||
return name
|
||||
|
||||
|
||||
|
@ -88,6 +88,7 @@ class Desc(object):
|
||||
self.ni = node['noindex']
|
||||
self.type = self.cls = self.name = self.params = ''
|
||||
self.count = 0
|
||||
self.name = ''
|
||||
|
||||
|
||||
class LaTeXTranslator(nodes.NodeVisitor):
|
||||
@ -321,6 +322,9 @@ class LaTeXTranslator(nodes.NodeVisitor):
|
||||
else:
|
||||
t2 = "{%s}" % d.name
|
||||
elif d.env == 'cfuncdesc':
|
||||
if d.cls:
|
||||
# C++ class names
|
||||
d.name = '%s::%s' % (d.cls, d.name)
|
||||
t2 = "{%s}{%s}{%s}" % (d.type, d.name, d.params)
|
||||
elif d.env == 'cmemberdesc':
|
||||
try:
|
||||
@ -341,18 +345,34 @@ class LaTeXTranslator(nodes.NodeVisitor):
|
||||
self.body.append(t1 + t2)
|
||||
|
||||
def visit_desc_type(self, node):
|
||||
d = self.descstack[-1]
|
||||
if d.env == 'describe':
|
||||
d.name += self.encode(node.astext())
|
||||
else:
|
||||
self.descstack[-1].type = self.encode(node.astext().strip())
|
||||
raise nodes.SkipNode
|
||||
|
||||
def visit_desc_name(self, node):
|
||||
d = self.descstack[-1]
|
||||
if d.env == 'describe':
|
||||
d.name += self.encode(node.astext())
|
||||
else:
|
||||
self.descstack[-1].name = self.encode(node.astext().strip())
|
||||
raise nodes.SkipNode
|
||||
|
||||
def visit_desc_classname(self, node):
|
||||
d = self.descstack[-1]
|
||||
if d.env == 'describe':
|
||||
d.name += self.encode(node.astext())
|
||||
else:
|
||||
self.descstack[-1].cls = self.encode(node.astext().strip())
|
||||
raise nodes.SkipNode
|
||||
|
||||
def visit_desc_parameterlist(self, node):
|
||||
d = self.descstack[-1]
|
||||
if d.env == 'describe':
|
||||
d.name += self.encode(node.astext())
|
||||
else:
|
||||
self.descstack[-1].params = self.encode(node.astext().strip())
|
||||
raise nodes.SkipNode
|
||||
|
||||
@ -362,7 +382,9 @@ class LaTeXTranslator(nodes.NodeVisitor):
|
||||
self.body.append("}\\\\")
|
||||
|
||||
def visit_desc_content(self, node):
|
||||
pass
|
||||
if node.children and isinstance(node.children[0], addnodes.desc):
|
||||
# avoid empty desc environment which causes a formatting bug
|
||||
self.body.append('~')
|
||||
def depart_desc_content(self, node):
|
||||
pass
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user