def render_fnt(f_name, doc_methods, parent_class, f_overloads):
R = rst_start
R += """
.. _{class_rst_ref}:
{f_name}
""".format(
f_name=f_name,
class_rst_ref=((parent_class.spelling + '_') if parent_class else '') +
f_name)
R += '=' * (len(f_name) + 0) + '\n' + """
**Synopsis**:
.. code-block:: c
"""
# Synopsis
R += make_synopsis_list(f_overloads, doc_methods) + '\n\n'
# Enumerate all overloads
for n, (m, doc) in enumerate(zip(f_overloads, doc_methods)):
doc_elem = doc.elements
num = '(%s)' % (n + 1) if len(f_overloads) > 1 else ''
R += num + doc.brief_doc + '\n'
R += replace_latex(render_note('note', doc_elem))
R += replace_latex(render_note('warning', doc_elem))
R += render_fig(doc_elem)
R += render_list(doc_elem['tparam'], 'Template parameters')
R += render_list(doc_elem['param'], 'Parameters')
if doc_elem['return']: R += head('Return value') + doc_elem['return']
if doc.processed_doc:
R += head('Documentation') + replace_latex(doc.processed_doc)
R += '\n\n'
# any example from the overloads
example_file_name = reduce(lambda x, y: x or y,
[d.elements['example']
for d in doc_methods] + [f_name], '')
code, d1, d2, s, e = prepare_example(example_file_name, 4)
if code:
R += """
Example
---------
{d1}
.. triqs_example::
linenos:{s},{e}
{code}
{d2}
""".format(**locals())
return R
def render_cls(cls, all_m, all_friend_functions, doc_methods, doc_class,
cls_doc):
doc_elem = doc_class.elements
R = rst_start
# include
incl = doc_elem['include']
if incl:
R += """
.. code-block:: c
#include <{incl}>
""".format(incl=incl.strip())
# class header
R += """
.. _{cls.spelling}:
{cls.spelling}
{separator}
{cls_doc.brief_doc}
{cls_doc.processed_doc}
**Synopsis**:
.. code-block:: c
{templ_synop}class {cls.spelling};
""".format(cls=cls,
separator='=' * (len(cls.spelling) + 2),
templ_synop=make_synopsis_template_decl(cls),
cls_doc=cls_doc)
# doc, note, warning, figure
R += replace_latex(doc_class.processed_doc)
R += replace_latex(render_note('note', doc_elem))
R += replace_latex(render_note('warning', doc_elem))
R += render_fig(doc_elem)
R += render_list(doc_elem['tparam'], 'Template parameters')
c_members = list(CL.get_members(cls, True))
if len(c_members) > 0:
R += head('Public members')
R += make_table(
['Member', 'Type', 'Comment'],
[(t.spelling, t.type.spelling,
replace_latex(t.raw_comment) if t.raw_comment else '')
for t in c_members])
c_usings = list(CL.get_usings(cls))
if len(c_usings) > 0:
R += head('Member types')
R += make_table(['Member type', 'Comment'], [
(t.spelling, replace_latex(t.raw_comment) if t.raw_comment else '')
for t in c_usings
])
if len(all_m) > 0:
R += head('Member functions')
R += make_table(['Member function', 'Comment'],
[(":ref:`%s <%s_%s>`" %
(name, escape_lg(cls.spelling), escape_lg(name)),
replace_latex(doc_methods[name][0].brief_doc))
for name in all_m])
R += toctree_hidden
for m_name in all_m:
R += " {cls.spelling}/{m_name}\n".format(cls=cls, m_name=m_name)
if len(all_friend_functions) > 0:
R += head('Non Member functions')
R += make_table(['Non member function', 'Comment'],
[(":ref:`%s <%s_%s>`" %
(name, escape_lg(cls.spelling), escape_lg(name)),
replace_latex(doc_methods[name][0].brief_doc))
for name in all_friend_functions])
R += toctree_hidden
for f_name in all_friend_functions:
R += " {cls.spelling}/{f_name}\n".format(cls=cls, f_name=f_name)
code, d1, d2, s, e = prepare_example(cls.spelling, 4)
if code is not None:
R += """
Example
---------
{d1}
.. triqs_example::
linenos:{s},{e}
{code}
{d2}
""".format(d1=d1, d2=d2, s=s, e=e, code=code)
return R