Generate Beautiful Project Documentation from Python Source Code Automatically

import ast
import inspect
from pathlib import Path

def extract_docstrings_from_file(filepath):
    """Parse a Python file and collect function docstrings."""
    source = Path(filepath).read_text()
    tree = ast.parse(source)

    docs = []
    for node in ast.walk(tree):
        if isinstance(node, (ast.FunctionDef, ast.AsyncFunctionDef)):
            name = node.name
            docstring = ast.get_docstring(node)
            if docstring:
                first_line = docstring.strip().split('\n')[0]
                docs.append((name, first_line, node.lineno))
    return docs

def generate_markdown_docs(filepath):
    """Produce a simple markdown summary from a Python file."""
    docs = extract_docstrings_from_file(filepath)
    if not docs:
        return "# No documentation found"

    lines = [f"# Documentation for `{Path(filepath).name}`\n"]
    lines.append("| Function | Description | Line |")
    lines.append("|----------|-------------|------|")
    for name, desc, lineno in docs:
        lines.append(f"| `{name}()` | {desc} | {lineno} |")
    return "\n".join(lines)

if __name__ == "__main__":
    # Example: document this script itself
    current_file = __file__
    print(generate_markdown_docs(current_file))