@dogsbay/autodoc-python 0.2.0-beta.41

package/dist/tree-builder.js

@@ -0,0 +1,279 @@
+import { relative } from "node:path";
+/** Make a source file path relative to the source root for display. */
+function relativeFile(file, sourceRoot) {
+    if (!sourceRoot)
+        return file;
+    return relative(sourceRoot, file);
+}
+/**
+ * Convert a SymbolInfo into a tree of API TreeNodes.
+ * These render through dedicated components (ApiSymbol, ApiDoc, ApiParams).
+ */
+export function symbolToTreeNode(symbol, options, md, fullPath, sourceRoot) {
+    if (symbol.kind === "module") {
+        return moduleToNode(symbol, options, md, fullPath, sourceRoot);
+    }
+    if (symbol.kind === "class") {
+        return classToNode(symbol, options, md, fullPath, sourceRoot);
+    }
+    return memberToNode(symbol, options, md, sourceRoot);
+}
+function classToNode(symbol, options, md, fullPath, sourceRoot) {
+    const children = [];
+    // Docstring
+    if (symbol.docstring) {
+        children.push({
+            type: "api-doc",
+            props: { html: md.render(dedentDoc(symbol.docstring)) },
+        });
+    }
+    // Constructor parameters (merged into class)
+    if (options.mergeInitIntoClass !== false && symbol.params.length > 0) {
+        children.push({
+            type: "api-params",
+            props: { params: renderParams(symbol.params, md, options) },
+        });
+    }
+    // Source code (collapsible)
+    if (options.showSource && symbol.sourceText) {
+        children.push({
+            type: "api-source",
+            props: {
+                code: symbol.sourceText,
+                file: relativeFile(symbol.source.file, sourceRoot),
+                line: symbol.source.line,
+            },
+        });
+    }
+    // Members
+    const members = filterMembers(symbol.members, options);
+    const filteredMembers = members.filter((m) => !(m.name === "__init__" && options.mergeInitIntoClass !== false));
+    if (options.groupByCategory) {
+        appendGroupedMembers(children, filteredMembers, options, md, sourceRoot);
+    }
+    else {
+        for (const member of filteredMembers) {
+            children.push(memberToNode(member, options, md, sourceRoot));
+        }
+    }
+    // Build full signature with params
+    const displayName = options.showRootFullPath && fullPath ? fullPath : symbol.name;
+    let signature = `class ${displayName}`;
+    if (symbol.bases.length > 0) {
+        signature = `class ${displayName}(${symbol.bases.join(", ")})`;
+    }
+    if (options.mergeInitIntoClass !== false && symbol.params.length > 0) {
+        const paramLines = symbol.params.map((p) => {
+            let s = `    ${p.name}`;
+            s += `: ${paramType(p, options)}`;
+            if (p.default)
+                s += ` = ${p.default}`;
+            return s + ",";
+        });
+        signature = `${displayName}(\n    *,\n${paramLines.join("\n")}\n)`;
+    }
+    return {
+        type: "api-class",
+        props: {
+            name: displayName,
+            kind: "class",
+            signature,
+            bases: options.showBases !== false ? symbol.bases : [],
+        },
+        children,
+    };
+}
+function moduleToNode(symbol, options, md, fullPath, sourceRoot) {
+    const children = [];
+    const displayName = options.showRootFullPath && fullPath ? fullPath : symbol.name;
+    if (symbol.docstring) {
+        children.push({
+            type: "api-doc",
+            props: { html: md.render(dedentDoc(symbol.docstring)) },
+        });
+    }
+    const members = filterMembers(symbol.members, options);
+    if (options.groupByCategory) {
+        appendGroupedMembers(children, members, options, md, sourceRoot);
+    }
+    else {
+        for (const member of members) {
+            children.push(memberToNode(member, options, md, sourceRoot));
+        }
+    }
+    return {
+        type: "api-class",
+        props: {
+            name: displayName,
+            kind: "module",
+            signature: null,
+            bases: [],
+        },
+        children,
+    };
+}
+function memberToNode(symbol, options, md, sourceRoot) {
+    const children = [];
+    // Docstring
+    if (symbol.docstring) {
+        children.push({
+            type: "api-doc",
+            props: { html: md.render(dedentDoc(symbol.docstring)) },
+        });
+    }
+    // Parameters (for functions/methods)
+    if (symbol.params.length > 0) {
+        children.push({
+            type: "api-params",
+            props: { params: renderParams(symbol.params, md, options) },
+        });
+    }
+    // Source code (collapsible)
+    if (options.showSource && symbol.sourceText) {
+        children.push({
+            type: "api-source",
+            props: {
+                code: symbol.sourceText,
+                file: relativeFile(symbol.source.file, sourceRoot),
+                line: symbol.source.line,
+            },
+        });
+    }
+    // Build signature
+    let signature = null;
+    const kind = symbol.kind === "property" ? "attr" : symbol.kind === "function" ? "func" : symbol.kind === "method" ? "meth" : symbol.kind;
+    if (kind === "attr") {
+        // Attribute: show value assignment
+        signature = symbol.signature;
+    }
+    else if (symbol.kind === "method" || symbol.kind === "function") {
+        // Method/function: call-style signature
+        if (symbol.params.length > 0) {
+            const paramLines = symbol.params.map((p) => {
+                let s = `    ${p.name}`;
+                s += `: ${paramType(p, options)}`;
+                if (p.default)
+                    s += ` = ${p.default}`;
+                return s + ",";
+            });
+            signature = `${symbol.name}(\n${paramLines.join("\n")}\n)`;
+        }
+        else {
+            signature = `${symbol.name}()`;
+        }
+    }
+    return {
+        type: "api-member",
+        props: {
+            name: symbol.name,
+            kind,
+            signature,
+            type: symbol.returnType,
+            default: symbol.params.length === 0 ? symbol.default : null,
+        },
+        children,
+    };
+}
+/**
+ * Get the display type for a parameter, respecting unwrapAnnotated option.
+ */
+function paramType(p, options) {
+    if (options.unwrapAnnotated !== false && p.bareType)
+        return p.bareType;
+    return p.bareType || p.type || "";
+}
+function renderParams(params, md, options) {
+    return params.map((p) => ({
+        name: p.name,
+        type: paramType(p, options) || null,
+        default: p.default || null,
+        required: p.required,
+        doc: p.doc ? dedentDoc(p.doc) : null,
+        docHtml: p.doc ? md.render(dedentDoc(p.doc)) : null,
+    }));
+}
+/**
+ * Group members by category and append to children with section headings.
+ */
+function appendGroupedMembers(children, members, options, md, sourceRoot) {
+    const groups = {};
+    const categoryOrder = ["Attributes", "Methods", "Classes", "Functions"];
+    for (const member of members) {
+        let category;
+        if (member.kind === "property" || member.kind === "variable") {
+            category = "Attributes";
+        }
+        else if (member.kind === "class") {
+            category = "Classes";
+        }
+        else if (member.kind === "method") {
+            category = "Methods";
+        }
+        else {
+            category = "Functions";
+        }
+        (groups[category] ??= []).push(member);
+    }
+    for (const category of categoryOrder) {
+        const group = groups[category];
+        if (!group || group.length === 0)
+            continue;
+        // Category heading
+        children.push({
+            type: "heading",
+            props: { level: (options.headingLevel ?? 2) + 1 },
+            children: [{ type: "prose", html: category }],
+        });
+        for (const member of group) {
+            children.push(memberToNode(member, options, md, sourceRoot));
+        }
+    }
+}
+function filterMembers(members, options) {
+    let filtered = [...members];
+    if (options.members && options.members.length > 0) {
+        const allowed = new Set(options.members);
+        filtered = filtered.filter((m) => allowed.has(m.name));
+        filtered.sort((a, b) => {
+            const aIdx = options.members.indexOf(a.name);
+            const bIdx = options.members.indexOf(b.name);
+            return aIdx - bIdx;
+        });
+    }
+    if (options.filters) {
+        for (const filter of options.filters) {
+            if (filter.startsWith("!")) {
+                const re = new RegExp(filter.slice(1));
+                filtered = filtered.filter((m) => !re.test(m.name));
+            }
+        }
+    }
+    if (options.membersOrder === "alphabetical") {
+        filtered.sort((a, b) => a.name.localeCompare(b.name));
+    }
+    return filtered;
+}
+function dedentDoc(text) {
+    const lines = text.split("\n");
+    let minIndent = Infinity;
+    for (let i = 0; i < lines.length; i++) {
+        if (lines[i].trim() === "")
+            continue;
+        const indent = lines[i].match(/^(\s*)/)?.[1].length ?? 0;
+        if (i === 0 && indent === 0)
+            continue;
+        if (indent < minIndent)
+            minIndent = indent;
+    }
+    if (minIndent === Infinity || minIndent === 0)
+        return text.trim();
+    return lines
+        .map((l) => {
+        if (l.trim() === "")
+            return "";
+        return l.startsWith(" ".repeat(minIndent)) ? l.slice(minIndent) : l;
+    })
+        .join("\n")
+        .trim();
+}
+//# sourceMappingURL=tree-builder.js.map

package/dist/tree-builder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-builder.js","sourceRoot":"","sources":["../src/tree-builder.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAKrC,uEAAuE;AACvE,SAAS,YAAY,CAAC,IAAY,EAAE,UAAmB;IACrD,IAAI,CAAC,UAAU;QAAE,OAAO,IAAI,CAAC;IAC7B,OAAO,QAAQ,CAAC,UAAU,EAAE,IAAI,CAAC,CAAC;AACpC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,gBAAgB,CAC9B,MAAkB,EAClB,OAAgC,EAChC,EAAc,EACd,QAAiB,EACjB,UAAmB;IAEnB,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC7B,OAAO,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IACjE,CAAC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;QAC5B,OAAO,WAAW,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,QAAQ,EAAE,UAAU,CAAC,CAAC;IAChE,CAAC;IACD,OAAO,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,WAAW,CAClB,MAAkB,EAClB,OAAgC,EAChC,EAAc,EACd,QAAiB,EACjB,UAAmB;IAEnB,MAAM,QAAQ,GAAe,EAAE,CAAC;IAEhC,YAAY;IACZ,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE;SACxD,CAAC,CAAC;IACL,CAAC;IAED,6CAA6C;IAC7C,IAAI,OAAO,CAAC,kBAAkB,KAAK,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrE,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,YAAY;YAClB,KAAK,EAAE,EAAE,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE;SAC5D,CAAC,CAAC;IACL,CAAC;IAED,4BAA4B;IAC5B,IAAI,OAAO,CAAC,UAAU,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QAC5C,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,YAAY;YAClB,KAAK,EAAE;gBACL,IAAI,EAAE,MAAM,CAAC,UAAU;gBACvB,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC;gBAClD,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI;aACzB;SACF,CAAC,CAAC;IACL,CAAC;IAED,UAAU;IACV,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACvD,MAAM,eAAe,GAAG,OAAO,CAAC,MAAM,CACpC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,UAAU,IAAI,OAAO,CAAC,kBAAkB,KAAK,KAAK,CAAC,CACxE,CAAC;IAEF,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC5B,oBAAoB,CAAC,QAAQ,EAAE,eAAe,EAAE,OAAO,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;IAC3E,CAAC;SAAM,CAAC;QACN,KAAK,MAAM,MAAM,IAAI,eAAe,EAAE,CAAC;YACrC,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED,mCAAmC;IACnC,MAAM,WAAW,GAAG,OAAO,CAAC,gBAAgB,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAClF,IAAI,SAAS,GAAG,SAAS,WAAW,EAAE,CAAC;IACvC,IAAI,MAAM,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC5B,SAAS,GAAG,SAAS,WAAW,IAAI,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IACjE,CAAC;IACD,IAAI,OAAO,CAAC,kBAAkB,KAAK,KAAK,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACrE,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;YACzC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;YACxB,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,CAAC;YAClC,IAAI,CAAC,CAAC,OAAO;gBAAE,CAAC,IAAI,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC;YACtC,OAAO,CAAC,GAAG,GAAG,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,SAAS,GAAG,GAAG,WAAW,cAAc,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;IACrE,CAAC;IAED,OAAO;QACL,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE;YACL,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,OAAO;YACb,SAAS;YACT,KAAK,EAAE,OAAO,CAAC,SAAS,KAAK,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE;SACvD;QACD,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CACnB,MAAkB,EAClB,OAAgC,EAChC,EAAc,EACd,QAAiB,EACjB,UAAmB;IAEnB,MAAM,QAAQ,GAAe,EAAE,CAAC;IAChC,MAAM,WAAW,GAAG,OAAO,CAAC,gBAAgB,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAElF,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE;SACxD,CAAC,CAAC;IACL,CAAC;IAED,MAAM,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAEvD,IAAI,OAAO,CAAC,eAAe,EAAE,CAAC;QAC5B,oBAAoB,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC;IACnE,CAAC;SAAM,CAAC;QACN,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;YAC7B,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI,EAAE,WAAW;QACjB,KAAK,EAAE;YACL,IAAI,EAAE,WAAW;YACjB,IAAI,EAAE,QAAQ;YACd,SAAS,EAAE,IAAI;YACf,KAAK,EAAE,EAAE;SACV;QACD,QAAQ;KACT,CAAC;AACJ,CAAC;AAED,SAAS,YAAY,CACnB,MAAkB,EAClB,OAAgC,EAChC,EAAc,EACd,UAAmB;IAEnB,MAAM,QAAQ,GAAe,EAAE,CAAC;IAEhC,YAAY;IACZ,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,EAAE,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,EAAE;SACxD,CAAC,CAAC;IACL,CAAC;IAED,qCAAqC;IACrC,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7B,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,YAAY;YAClB,KAAK,EAAE,EAAE,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE;SAC5D,CAAC,CAAC;IACL,CAAC;IAED,4BAA4B;IAC5B,IAAI,OAAO,CAAC,UAAU,IAAI,MAAM,CAAC,UAAU,EAAE,CAAC;QAC5C,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,YAAY;YAClB,KAAK,EAAE;gBACL,IAAI,EAAE,MAAM,CAAC,UAAU;gBACvB,IAAI,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,UAAU,CAAC;gBAClD,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI;aACzB;SACF,CAAC,CAAC;IACL,CAAC;IAED,kBAAkB;IAClB,IAAI,SAAS,GAAkB,IAAI,CAAC;IACpC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC;IAEzI,IAAI,IAAI,KAAK,MAAM,EAAE,CAAC;QACpB,mCAAmC;QACnC,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC;IAC/B,CAAC;SAAM,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QAClE,wCAAwC;QACxC,IAAI,MAAM,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;gBACzC,IAAI,CAAC,GAAG,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;gBACxB,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,EAAE,CAAC;gBAClC,IAAI,CAAC,CAAC,OAAO;oBAAE,CAAC,IAAI,MAAM,CAAC,CAAC,OAAO,EAAE,CAAC;gBACtC,OAAO,CAAC,GAAG,GAAG,CAAC;YACjB,CAAC,CAAC,CAAC;YACH,SAAS,GAAG,GAAG,MAAM,CAAC,IAAI,MAAM,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;QAC7D,CAAC;aAAM,CAAC;YACN,SAAS,GAAG,GAAG,MAAM,CAAC,IAAI,IAAI,CAAC;QACjC,CAAC;IACH,CAAC;IAED,OAAO;QACL,IAAI,EAAE,YAAY;QAClB,KAAK,EAAE;YACL,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,IAAI;YACJ,SAAS;YACT,IAAI,EAAE,MAAM,CAAC,UAAU;YACvB,OAAO,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAE,MAAc,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI;SACrE;QACD,QAAQ;KACT,CAAC;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,SAAS,CAAC,CAAY,EAAE,OAAgC;IAC/D,IAAI,OAAO,CAAC,eAAe,KAAK,KAAK,IAAI,CAAC,CAAC,QAAQ;QAAE,OAAO,CAAC,CAAC,QAAQ,CAAC;IACvE,OAAO,CAAC,CAAC,QAAQ,IAAI,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC;AACpC,CAAC;AAED,SAAS,YAAY,CACnB,MAAmB,EACnB,EAAc,EACd,OAAgC;IAShC,OAAO,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;QACxB,IAAI,EAAE,CAAC,CAAC,IAAI;QACZ,IAAI,EAAE,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,IAAI,IAAI;QACnC,OAAO,EAAE,CAAC,CAAC,OAAO,IAAI,IAAI;QAC1B,QAAQ,EAAE,CAAC,CAAC,QAAQ;QACpB,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI;QACpC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI;KACpD,CAAC,CAAC,CAAC;AACN,CAAC;AAED;;GAEG;AACH,SAAS,oBAAoB,CAC3B,QAAoB,EACpB,OAAqB,EACrB,OAAgC,EAChC,EAAc,EACd,UAAmB;IAEnB,MAAM,MAAM,GAAiC,EAAE,CAAC;IAChD,MAAM,aAAa,GAAG,CAAC,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC;IAExE,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE,CAAC;QAC7B,IAAI,QAAgB,CAAC;QACrB,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,IAAI,MAAM,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;YAC7D,QAAQ,GAAG,YAAY,CAAC;QAC1B,CAAC;aAAM,IAAI,MAAM,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YACnC,QAAQ,GAAG,SAAS,CAAC;QACvB,CAAC;aAAM,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;YACpC,QAAQ,GAAG,SAAS,CAAC;QACvB,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,WAAW,CAAC;QACzB,CAAC;QACD,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzC,CAAC;IAED,KAAK,MAAM,QAAQ,IAAI,aAAa,EAAE,CAAC;QACrC,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC/B,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,SAAS;QAE3C,mBAAmB;QACnB,QAAQ,CAAC,IAAI,CAAC;YACZ,IAAI,EAAE,SAAS;YACf,KAAK,EAAE,EAAE,KAAK,EAAE,CAAC,OAAO,CAAC,YAAY,IAAI,CAAC,CAAC,GAAG,CAAC,EAAE;YACjD,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;SAC9C,CAAC,CAAC;QAEH,KAAK,MAAM,MAAM,IAAI,KAAK,EAAE,CAAC;YAC3B,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,UAAU,CAAC,CAAC,CAAC;QAC/D,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,aAAa,CACpB,OAAqB,EACrB,OAAgC;IAEhC,IAAI,QAAQ,GAAG,CAAC,GAAG,OAAO,CAAC,CAAC;IAE5B,IAAI,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClD,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;QACzC,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QACvD,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;YACrB,MAAM,IAAI,GAAG,OAAO,CAAC,OAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC9C,MAAM,IAAI,GAAG,OAAO,CAAC,OAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;YAC9C,OAAO,IAAI,GAAG,IAAI,CAAC;QACrB,CAAC,CAAC,CAAC;IACL,CAAC;IAED,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;QACpB,KAAK,MAAM,MAAM,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;YACrC,IAAI,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC3B,MAAM,EAAE,GAAG,IAAI,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;gBACvC,QAAQ,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;YACtD,CAAC;QACH,CAAC;IACH,CAAC;IAED,IAAI,OAAO,CAAC,YAAY,KAAK,cAAc,EAAE,CAAC;QAC5C,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;IACxD,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED,SAAS,SAAS,CAAC,IAAY;IAC7B,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC/B,IAAI,SAAS,GAAG,QAAQ,CAAC;IACzB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,SAAS;QACrC,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC;QACzD,IAAI,CAAC,KAAK,CAAC,IAAI,MAAM,KAAK,CAAC;YAAE,SAAS;QACtC,IAAI,MAAM,GAAG,SAAS;YAAE,SAAS,GAAG,MAAM,CAAC;IAC7C,CAAC;IACD,IAAI,SAAS,KAAK,QAAQ,IAAI,SAAS,KAAK,CAAC;QAAE,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;IAClE,OAAO,KAAK;SACT,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACT,IAAI,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE;YAAE,OAAO,EAAE,CAAC;QAC/B,OAAO,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtE,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC;SACV,IAAI,EAAE,CAAC;AACZ,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,128 @@
+/**
+ * Structured representation of a Python symbol extracted from source.
+ */
+export interface SymbolInfo {
+    name: string;
+    kind: "class" | "function" | "method" | "property" | "module" | "variable";
+    /** Full signature string, e.g. "def get(path: str, *, response_model: Type = None) -> Callable" */
+    signature: string;
+    /** Raw docstring text (triple-quoted string) */
+    docstring: string | null;
+    /** Parsed docstring sections */
+    doc?: ParsedDocstring;
+    /** Decorator strings, e.g. ["@app.get", "@deprecated"] */
+    decorators: string[];
+    /** Base classes for classes, e.g. ["Starlette"] */
+    bases: string[];
+    /** Parsed parameter information */
+    params: ParamInfo[];
+    /** Return type annotation */
+    returnType: string | null;
+    /** Child symbols (methods, nested classes, properties) */
+    members: SymbolInfo[];
+    /** Source location */
+    source: {
+        file: string;
+        line: number;
+    };
+    /** Full source text of the symbol (for show_source) */
+    sourceText?: string;
+}
+/**
+ * Parameter information extracted from function/method signatures.
+ */
+export interface ParamInfo {
+    name: string;
+    /** Type annotation (may be complex, e.g. "Annotated[str, Doc('...')]") */
+    type: string | null;
+    /** Raw type without Annotated wrapper */
+    bareType: string | null;
+    /** Default value as string */
+    default: string | null;
+    /** Documentation from docstring or Annotated[type, Doc("...")] */
+    doc: string | null;
+    /** Whether parameter is required (no default) */
+    required: boolean;
+    /** Whether this is *args or **kwargs */
+    kind: "positional" | "keyword" | "var_positional" | "var_keyword" | "keyword_only";
+}
+/**
+ * Parsed docstring with sections.
+ * Supports Google, NumPy, and Sphinx styles.
+ */
+export interface ParsedDocstring {
+    /** Summary/description (first paragraph) */
+    summary: string;
+    /** Extended description (remaining paragraphs before sections) */
+    description: string;
+    /** Parameter docs from docstring (may be overridden by Annotated[type, Doc()]) */
+    params: DocstringParam[];
+    /** Return value documentation */
+    returns: DocstringReturn | null;
+    /** Raised exceptions */
+    raises: DocstringRaise[];
+    /** Example code blocks */
+    examples: string[];
+    /** Notes section */
+    notes: string[];
+    /** Deprecation notice */
+    deprecated: string | null;
+}
+export interface DocstringParam {
+    name: string;
+    type: string | null;
+    description: string;
+}
+export interface DocstringReturn {
+    type: string | null;
+    description: string;
+}
+export interface DocstringRaise {
+    type: string;
+    description: string;
+}
+/**
+ * Options for the autodoc plugin.
+ */
+export interface AutodocOptions {
+    /** Root directory containing Python source packages */
+    sourceRoot: string;
+    /** Global handler options (can be overridden per-directive) */
+    globalOptions?: AutodocDirectiveOptions;
+}
+/**
+ * Options for a single ::: directive (from YAML block).
+ */
+export interface AutodocDirectiveOptions {
+    /** Specific members to document (whitelist) */
+    members?: string[];
+    /** Show the root heading for the symbol */
+    showRootHeading?: boolean;
+    /** Show members even without docstrings */
+    showIfNoDocstring?: boolean;
+    /** Include inherited members */
+    inheritedMembers?: boolean;
+    /** Member ordering: "source" | "alphabetical" */
+    membersOrder?: "source" | "alphabetical";
+    /** Merge __init__ parameters into class documentation */
+    mergeInitIntoClass?: boolean;
+    /** Show signature in a separate code block */
+    separateSignature?: boolean;
+    /** Regex filters for excluding members, e.g. ["!^_"] */
+    filters?: string[];
+    /** Heading level for the root symbol */
+    headingLevel?: number;
+    /** Show collapsible source code block */
+    showSource?: boolean;
+    /** Strip Annotated[T, ...] to T in signatures */
+    unwrapAnnotated?: boolean;
+    /** Group members by category (Attributes, Methods, Classes) */
+    groupByCategory?: boolean;
+    /** Show full dotted path in root heading (e.g. fastapi.FastAPI) */
+    showRootFullPath?: boolean;
+    /** Show base classes for classes */
+    showBases?: boolean;
+    /** Show function/method signatures */
+    showSignature?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,UAAU;IACzB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,OAAO,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,UAAU,CAAC;IAC3E,mGAAmG;IACnG,SAAS,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,gCAAgC;IAChC,GAAG,CAAC,EAAE,eAAe,CAAC;IACtB,0DAA0D;IAC1D,UAAU,EAAE,MAAM,EAAE,CAAC;IACrB,mDAAmD;IACnD,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,mCAAmC;IACnC,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,6BAA6B;IAC7B,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,0DAA0D;IAC1D,OAAO,EAAE,UAAU,EAAE,CAAC;IACtB,sBAAsB;IACtB,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;IACvC,uDAAuD;IACvD,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,IAAI,EAAE,MAAM,CAAC;IACb,0EAA0E;IAC1E,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,yCAAyC;IACzC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,8BAA8B;IAC9B,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,kEAAkE;IAClE,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;IACnB,iDAAiD;IACjD,QAAQ,EAAE,OAAO,CAAC;IAClB,wCAAwC;IACxC,IAAI,EAAE,YAAY,GAAG,SAAS,GAAG,gBAAgB,GAAG,aAAa,GAAG,cAAc,CAAC;CACpF;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAC;IAChB,kEAAkE;IAClE,WAAW,EAAE,MAAM,CAAC;IACpB,kFAAkF;IAClF,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,iCAAiC;IACjC,OAAO,EAAE,eAAe,GAAG,IAAI,CAAC;IAChC,wBAAwB;IACxB,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,0BAA0B;IAC1B,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,oBAAoB;IACpB,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,yBAAyB;IACzB,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,uDAAuD;IACvD,UAAU,EAAE,MAAM,CAAC;IACnB,+DAA+D;IAC/D,aAAa,CAAC,EAAE,uBAAuB,CAAC;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC,+CAA+C;IAC/C,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,2CAA2C;IAC3C,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2CAA2C;IAC3C,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,gCAAgC;IAChC,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,iDAAiD;IACjD,YAAY,CAAC,EAAE,QAAQ,GAAG,cAAc,CAAC;IACzC,yDAAyD;IACzD,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,8CAA8C;IAC9C,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,wDAAwD;IACxD,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,wCAAwC;IACxC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,yCAAyC;IACzC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iDAAiD;IACjD,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,+DAA+D;IAC/D,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,mEAAmE;IACnE,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,oCAAoC;IACpC,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,sCAAsC;IACtC,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB"}

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@dogsbay/autodoc-python",
+  "version": "0.2.0-beta.41",
+  "description": "Pure-JS Python autodoc engine for Dogsbay — tree-sitter-WASM-based Python AST → SymbolInfo → TreeNode. Compatible with mkdocstrings ::: directive semantics.",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "devDependencies": {
+    "@types/markdown-it": "^14.1.0",
+    "@types/node": "^25.5.0",
+    "typescript": "^5.7.0",
+    "vitest": "^3.0.0"
+  },
+  "dependencies": {
+    "markdown-it": "^14.1.0",
+    "tree-sitter-python": "^0.25.0",
+    "web-tree-sitter": "^0.26.8",
+    "yaml": "^2.8.3",
+    "@dogsbay/types": "0.2.0-beta.41"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dogsbay/dogsbay.git",
+    "directory": "packages/autodoc-python"
+  },
+  "homepage": "https://github.com/dogsbay/dogsbay/tree/main/packages/autodoc-python",
+  "bugs": {
+    "url": "https://github.com/dogsbay/dogsbay/issues"
+  },
+  "scripts": {
+    "build": "tsc",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  }
+}