def docstring(app, what, name, obj, options, lines):
"""Converts doc-strings from (Commonmark) Markdown to reStructuredText."""
md = '\n'.join(lines)
ast = commonmark.Parser().parse(md)
rst = commonmark.ReStructuredTextRenderer().render(ast)
lines.clear()
lines += rst.splitlines()
def docstring(app, what, name, obj, options, lines):
md = '\n'.join(lines)
ast = commonmark.Parser().parse(md)
rst = commonmark.ReStructuredTextRenderer().render(ast)
lines.clear()
for line in rst.splitlines():
lines.append(line)
def docstring(app, what, name, obj, options, lines):
text = []
in_arg = False
arg_txt = ''
arg_name = None
for l in lines:
if arg_name:
if len(l) and l[0]==' ':
# Continues argument description
arg_txt += ' ' + l.strip()
continue
text.append('* `' + arg_name + '`: ' + arg_txt)
arg_name = None
if is_line.match(l):
continue
arg_name = var_name.match(l)
if arg_name:
arg_txt = arg_name.group('desc')
arg_name = arg_name.group('name')
print((arg_txt, arg_name))
else:
text.append(l)
if arg_name:
text.append('* `' + arg_name + '`: ' + arg_txt)
md = '\n'.join(text)
ast = commonmark.Parser().parse(md)
rst = commonmark.ReStructuredTextRenderer().render(ast)
lines.clear()
for line in rst.splitlines():
line = re.sub(r'\$(?P<eqn>[^$]*)\$', r':math:`\1`', line)
print(line)
lines.append(line)
def doc_strings(app, what, name, obj, options, lines):
"""Converts doc-strings from Markdown to reStructuredText."""
tweaked = syntax_tweaks(lines)
markdown = '\n'.join(tweaked)
parsed = commonmark.Parser().parse(markdown)
restruct = commonmark.ReStructuredTextRenderer().render(parsed)
lines.clear()
lines += restruct.splitlines()
def docstring(
app,
what,
name,
obj,
options,
lines,
): # pylint: disable=unused-argument, too-many-arguments
"""Helper function to render docstring using markdown"""
md = "\n".join(lines)
ast = commonmark.Parser().parse(md)
rst = commonmark.ReStructuredTextRenderer().render(ast)
lines.clear()
for line in rst.splitlines():
lines.append(line)
def _md2rst(docstring):
parser = commonmark.Parser()
ast = parser.parse(docstring)
renderer = commonmark.ReStructuredTextRenderer()
return renderer.render(ast)
def docstring(app, what, name, obj, options, lines):
md = "\n".join(lines)
ast = commonmark.Parser().parse(md)
rst = commonmark.ReStructuredTextRenderer().render(ast)
lines.clear()
lines += rst.splitlines()
def setUp(self):
self.parser = commonmark.Parser()
self.renderer = commonmark.ReStructuredTextRenderer()
def _docstring(_app, _what, _name, _obj, _options, lines: List[str]) -> None:
markdown: str = "\n".join(lines)
ast = commonmark.Parser().parse(markdown)
rst = commonmark.ReStructuredTextRenderer().render(ast)
lines.clear()
lines += rst.splitlines()
