def generate_module_markdown()

in flowtorch/docs.py [0:0]


def generate_module_markdown(symbol_name: str, entity: Any) -> str:
    markdown = []

    # Docstring
    # TODO: Parse docstring and extract short summary
    docstring = entity.__doc__ if entity.__doc__ is not None else "empty docstring"
    docstring = "\n".join(line.strip() for line in docstring.splitlines())

    # short_summary = "```short summary```\n"
    safe_name = symbol_name.replace("_", r"\_")

    # Create top section for class
    markdown.append("<PythonModule>\n")
    markdown.append(
        """<div className="doc-module-row">
<div className="doc-module-label"><span className="doc-symbol-label">module</span></div>
<div className="doc-module-signature">\n"""
    )

    markdown.append(
        f"""## <span className="doc-symbol-name">{safe_name}</span> {{#module}}\n"""
    )
    # markdown.append(short_summary)
    markdown.append("</div>\n</div>\n\n</PythonModule>\n")
    markdown.append(f"```\n{docstring}\n```\n")

    return "\n".join(markdown)