Skip to content
Thor Whalen edited this page Mar 30, 2021 · 2 revisions

Markdown to ReStructuredText (md2rst)

https://www.sphinx-doc.org/en/master/usage/markdown.html

How to add/transform docs in modules

https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html?highlight=%27autodoc-process-docstring%27

Example:

def custom_parser(app, what, name, obj, options, lines):
    import inspect
    print(inspect.getsource(obj))
    print(lines)
    lines.append('')
    lines.append(f'CUSTOM ADDS ARE HERE: {name}')
    lines.append('')
    lines.append()
    lines.extend(inspect.getsource(obj).splitlines())
def setup(app):
    app.connect('autodoc-process-docstring', custom_parser)