@apify/docusaurus-plugin-typedoc-api 5.1.7 → 5.1.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/components/Comment.d.ts.map +1 -1
- package/lib/components/Comment.js +3 -2
- package/lib/components/Comment.js.map +1 -1
- package/lib/components/styles.css +6 -0
- package/lib/plugin/python/index.d.ts.map +1 -1
- package/lib/plugin/python/index.js +4 -1
- package/lib/plugin/python/index.js.map +1 -1
- package/package.json +1 -1
- package/src/components/Comment.tsx +9 -0
- package/src/components/styles.css +6 -0
- package/src/plugin/python/index.ts +7 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Comment.d.ts","sourceRoot":"","sources":["../../src/components/Comment.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAG1C,MAAM,WAAW,YAAY;IAC5B,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC;IAC7B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,wBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,GAAG,OAAO,CAShE;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,UAAU,CAAC,kBAAkB,EAAE,GAAG,MAAM,CAUrF;AAED,wBAAgB,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,QAAa,EAAE,EAAE,YAAY,
|
|
1
|
+
{"version":3,"file":"Comment.d.ts","sourceRoot":"","sources":["../../src/components/Comment.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAG1C,MAAM,WAAW,YAAY;IAC5B,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,CAAC;IAC7B,IAAI,CAAC,EAAE,OAAO,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;CACpB;AAED,wBAAgB,UAAU,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC,OAAO,GAAG,OAAO,CAShE;AAED,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,UAAU,CAAC,kBAAkB,EAAE,GAAG,MAAM,CAUrF;AAED,wBAAgB,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,QAAa,EAAE,EAAE,YAAY,2CAkDrE"}
|
|
@@ -21,18 +21,19 @@ export function displayPartsToMarkdown(parts) {
|
|
|
21
21
|
.join('');
|
|
22
22
|
}
|
|
23
23
|
export function Comment({ comment, root, hideTags = [] }) {
|
|
24
|
-
var _a, _b;
|
|
24
|
+
var _a, _b, _c;
|
|
25
25
|
if (!comment || !hasComment(comment)) {
|
|
26
26
|
return null;
|
|
27
27
|
}
|
|
28
28
|
// Hide custom tags.
|
|
29
29
|
hideTags.push('@reference');
|
|
30
|
+
hideTags.push('@since');
|
|
30
31
|
const blockTags = (_b = (_a = comment.blockTags) === null || _a === void 0 ? void 0 : _a.filter((tag) => {
|
|
31
32
|
if (hideTags.includes(tag.tag)) {
|
|
32
33
|
return false;
|
|
33
34
|
}
|
|
34
35
|
return tag.tag !== '@default';
|
|
35
36
|
})) !== null && _b !== void 0 ? _b : [];
|
|
36
|
-
return (_jsxs("div", { className: `tsd-comment tsd-typography ${root ? 'tsd-comment-root' : ''}`, children: [!!comment.summary && (_jsx("div", { className: "lead", children: _jsx(Markdown, { content: displayPartsToMarkdown(comment.summary) }) })), blockTags.length > 0 && (_jsx("dl", { className: "tsd-comment-tags", children: blockTags.map((tag) => (_jsxs(Fragment, { children: [_jsx("dt", { children: _jsx("strong", { children: tag.tag }) }), _jsx("dd", { children: _jsx(Markdown, { content: displayPartsToMarkdown(tag.content) }) })] }, tag.tag))) }))] }));
|
|
37
|
+
return (_jsxs("div", { className: `tsd-comment tsd-typography ${root ? 'tsd-comment-root' : ''}`, children: [!!comment.summary && (_jsx("div", { className: "lead", children: _jsx(Markdown, { content: displayPartsToMarkdown(comment.summary) }) })), blockTags.length > 0 && (_jsx("dl", { className: "tsd-comment-tags", children: blockTags.map((tag) => (_jsxs(Fragment, { children: [_jsx("dt", { children: _jsx("strong", { children: tag.tag }) }), _jsx("dd", { children: _jsx(Markdown, { content: displayPartsToMarkdown(tag.content) }) })] }, tag.tag))) })), comment.blockTags.some((tag) => tag.tag === '@since') && (_jsx("div", { className: "tsd-comment-since", children: _jsx(Markdown, { content: displayPartsToMarkdown((_c = comment.blockTags.find((tag) => tag.tag === '@since')) === null || _c === void 0 ? void 0 : _c.content) }) }))] }));
|
|
37
38
|
}
|
|
38
39
|
//# sourceMappingURL=Comment.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Comment.js","sourceRoot":"","sources":["../../src/components/Comment.tsx"],"names":[],"mappings":";AAAA,oGAAoG;AACpG,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAQtC,MAAM,UAAU,UAAU,CAAC,OAA4B;;IACtD,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,OAAO,KAAK,CAAC;IACd,CAAC;IAED,OAAO,OAAO,CACb,CAAA,MAAA,OAAO,CAAC,OAAO,0CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC;QAC/D,CAAC,OAAO,CAAC,SAAS,IAAI,CAAA,MAAA,OAAO,CAAC,SAAS,0CAAE,MAAM,IAAG,CAAC,CAAC,CACrD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,KAAsC;IAC5E,OAAO,KAAK;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YAChC,OAAO,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC;QACrC,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC,CAAC;SACD,IAAI,CAAC,EAAE,CAAC,CAAC;AACZ,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,GAAG,EAAE,EAAgB;;IACrE,IAAI,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,oBAAoB;IACpB,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"Comment.js","sourceRoot":"","sources":["../../src/components/Comment.tsx"],"names":[],"mappings":";AAAA,oGAAoG;AACpG,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAEjC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAQtC,MAAM,UAAU,UAAU,CAAC,OAA4B;;IACtD,IAAI,CAAC,OAAO,EAAE,CAAC;QACd,OAAO,KAAK,CAAC;IACd,CAAC;IAED,OAAO,OAAO,CACb,CAAA,MAAA,OAAO,CAAC,OAAO,0CAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC;QAC/D,CAAC,OAAO,CAAC,SAAS,IAAI,CAAA,MAAA,OAAO,CAAC,SAAS,0CAAE,MAAM,IAAG,CAAC,CAAC,CACrD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,KAAsC;IAC5E,OAAO,KAAK;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QACb,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;YAChC,OAAO,IAAI,IAAI,CAAC,GAAG,IAAI,IAAI,CAAC,IAAI,GAAG,CAAC;QACrC,CAAC;QAED,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC,CAAC;SACD,IAAI,CAAC,EAAE,CAAC,CAAC;AACZ,CAAC;AAED,MAAM,UAAU,OAAO,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,GAAG,EAAE,EAAgB;;IACrE,IAAI,CAAC,OAAO,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACtC,OAAO,IAAI,CAAC;IACb,CAAC;IAED,oBAAoB;IACpB,QAAQ,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;IAC5B,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IAExB,MAAM,SAAS,GACd,MAAA,MAAA,OAAO,CAAC,SAAS,0CAAE,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE;QACjC,IAAI,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YAChC,OAAO,KAAK,CAAC;QACd,CAAC;QAED,OAAO,GAAG,CAAC,GAAG,KAAK,UAAU,CAAC;IAC/B,CAAC,CAAC,mCAAI,EAAE,CAAC;IAEV,OAAO,CACN,eAAK,SAAS,EAAE,8BAA8B,IAAI,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,EAAE,EAAE,aAC5E,CAAC,CAAC,OAAO,CAAC,OAAO,IAAI,CACrB,cAAK,SAAS,EAAC,MAAM,YACpB,KAAC,QAAQ,IAAC,OAAO,EAAE,sBAAsB,CAAC,OAAO,CAAC,OAAO,CAAC,GAAI,GACzD,CACN,EAEA,SAAS,CAAC,MAAM,GAAG,CAAC,IAAI,CACxB,aAAI,SAAS,EAAC,kBAAkB,YAC9B,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CACvB,MAAC,QAAQ,eACR,uBACC,2BAAS,GAAG,CAAC,GAAG,GAAU,GACtB,EACL,uBACC,KAAC,QAAQ,IAAC,OAAO,EAAE,sBAAsB,CAAC,GAAG,CAAC,OAAO,CAAC,GAAI,GACtD,KANS,GAAG,CAAC,GAAG,CAOX,CACX,CAAC,GACE,CACL,EAGA,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,QAAQ,CAAC,IAAI,CACxD,cAAK,SAAS,EAAC,mBAAmB,YACjC,KAAC,QAAQ,IAAC,OAAO,EAAE,sBAAsB,CAAC,MAAA,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,QAAQ,CAAC,0CAAE,OAAO,CAAC,GAAI,GACxG,CACN,IAEG,CACN,CAAC;AACH,CAAC"}
|
|
@@ -191,6 +191,12 @@ html[data-theme='light'] .tsd-panel-content {
|
|
|
191
191
|
margin-bottom: 0;
|
|
192
192
|
}
|
|
193
193
|
|
|
194
|
+
.tsd-comment-since {
|
|
195
|
+
font-style: italic;
|
|
196
|
+
font-size: 90%;
|
|
197
|
+
margin-top: 1em;
|
|
198
|
+
}
|
|
199
|
+
|
|
194
200
|
.tsd-comment-root {
|
|
195
201
|
margin-top: 0;
|
|
196
202
|
margin-bottom: var(--tsd-spacing-vertical-full);
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugin/python/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,EACjC,gBAAgB,EAChB,mBAAmB,EACnB,OAAO,EACP,WAAW,GACX,EAAE;IACF,gBAAgB,EAAE,MAAM,CAAC;IACzB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACpB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/plugin/python/index.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,EACjC,gBAAgB,EAChB,mBAAmB,EACnB,OAAO,EACP,WAAW,GACX,EAAE;IACF,gBAAgB,EAAE,MAAM,CAAC;IACzB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,EAAE,MAAM,CAAC;CACpB,QAqCA"}
|
|
@@ -16,7 +16,10 @@ export function processPythonDocs({ pythonModulePath, moduleShortcutsPath, outPa
|
|
|
16
16
|
pydocMarkdownDumpPath,
|
|
17
17
|
]);
|
|
18
18
|
if (out.error) {
|
|
19
|
-
throw new Error(out.error.message);
|
|
19
|
+
throw new Error(`Failed to spawn the generate_ast.py script: ${out.error.message}`);
|
|
20
|
+
}
|
|
21
|
+
if (out.status !== 0) {
|
|
22
|
+
throw new Error(`The generate_ast.py script failed with exit code ${out.status}:\n${out.stderr.toString()}`);
|
|
20
23
|
}
|
|
21
24
|
const moduleShortcuts = JSON.parse(fs.readFileSync(moduleShortcutsPath, 'utf8'));
|
|
22
25
|
const pydocMarkdownDump = JSON.parse(fs.readFileSync(pydocMarkdownDumpPath, 'utf8'));
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/plugin/python/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAGtD,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,EACjC,gBAAgB,EAChB,mBAAmB,EACnB,OAAO,EACP,WAAW,GAMX;IACA,MAAM,qBAAqB,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAC;IAEjF,MAAM,GAAG,GAAG,YAAY,CAAC,SAAS,CAAC,QAAQ,EAAE;QAC5C,IAAI,CAAC,IAAI,CAAC,SAAS,EAAG,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,8CAA8C,CAAC;QACvF,IAAI;QACJ,gBAAgB;QAChB,qBAAqB;KACrB,CAAC,CAAC;IAEH,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/plugin/python/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAGtD,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEpC;;;GAGG;AACH,MAAM,UAAU,iBAAiB,CAAC,EACjC,gBAAgB,EAChB,mBAAmB,EACnB,OAAO,EACP,WAAW,GAMX;IACA,MAAM,qBAAqB,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,4BAA4B,CAAC,CAAC;IAEjF,MAAM,GAAG,GAAG,YAAY,CAAC,SAAS,CAAC,QAAQ,EAAE;QAC5C,IAAI,CAAC,IAAI,CAAC,SAAS,EAAG,IAAI,EAAE,IAAI,EAAE,IAAI,EAAE,8CAA8C,CAAC;QACvF,IAAI;QACJ,gBAAgB;QAChB,qBAAqB;KACrB,CAAC,CAAC;IAEH,IAAI,GAAG,CAAC,KAAK,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,+CAA+C,GAAG,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC;IACrF,CAAC;IAED,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACtB,MAAM,IAAI,KAAK,CACd,oDAAoD,GAAG,CAAC,MAAM,MAAM,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,EAAE,CAC3F,CAAC;IACH,CAAC;IAED,MAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,YAAY,CAAC,mBAAmB,EAAE,MAAM,CAAC,CAG9E,CAAC;IAEF,MAAM,iBAAiB,GAAG,IAAI,CAAC,KAAK,CACnC,EAAE,CAAC,YAAY,CAAC,qBAAqB,EAAE,MAAM,CAAC,CAC3B,CAAC;IAErB,MAAM,kBAAkB,GAAG,IAAI,kBAAkB,CAAC;QACjD,WAAW;QACX,eAAe;KACf,CAAC,CAAC;IAEH,MAAM,mBAAmB,GAAG,kBAAkB,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAE5E,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,mBAAmB,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;AACzE,CAAC"}
|
package/package.json
CHANGED
|
@@ -39,6 +39,7 @@ export function Comment({ comment, root, hideTags = [] }: CommentProps) {
|
|
|
39
39
|
|
|
40
40
|
// Hide custom tags.
|
|
41
41
|
hideTags.push('@reference');
|
|
42
|
+
hideTags.push('@since');
|
|
42
43
|
|
|
43
44
|
const blockTags =
|
|
44
45
|
comment.blockTags?.filter((tag) => {
|
|
@@ -71,6 +72,14 @@ export function Comment({ comment, root, hideTags = [] }: CommentProps) {
|
|
|
71
72
|
))}
|
|
72
73
|
</dl>
|
|
73
74
|
)}
|
|
75
|
+
|
|
76
|
+
{
|
|
77
|
+
comment.blockTags.some((tag) => tag.tag === '@since') && (
|
|
78
|
+
<div className="tsd-comment-since">
|
|
79
|
+
<Markdown content={displayPartsToMarkdown(comment.blockTags.find((tag) => tag.tag === '@since')?.content)} />
|
|
80
|
+
</div>
|
|
81
|
+
)
|
|
82
|
+
}
|
|
74
83
|
</div>
|
|
75
84
|
);
|
|
76
85
|
}
|
|
@@ -191,6 +191,12 @@ html[data-theme='light'] .tsd-panel-content {
|
|
|
191
191
|
margin-bottom: 0;
|
|
192
192
|
}
|
|
193
193
|
|
|
194
|
+
.tsd-comment-since {
|
|
195
|
+
font-style: italic;
|
|
196
|
+
font-size: 90%;
|
|
197
|
+
margin-top: 1em;
|
|
198
|
+
}
|
|
199
|
+
|
|
194
200
|
.tsd-comment-root {
|
|
195
201
|
margin-top: 0;
|
|
196
202
|
margin-bottom: var(--tsd-spacing-vertical-full);
|
|
@@ -31,7 +31,13 @@ export function processPythonDocs({
|
|
|
31
31
|
]);
|
|
32
32
|
|
|
33
33
|
if (out.error) {
|
|
34
|
-
throw new Error(out.error.message);
|
|
34
|
+
throw new Error(`Failed to spawn the generate_ast.py script: ${out.error.message}`);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
if (out.status !== 0) {
|
|
38
|
+
throw new Error(
|
|
39
|
+
`The generate_ast.py script failed with exit code ${out.status}:\n${out.stderr.toString()}`,
|
|
40
|
+
);
|
|
35
41
|
}
|
|
36
42
|
|
|
37
43
|
const moduleShortcuts = JSON.parse(fs.readFileSync(moduleShortcutsPath, 'utf8')) as Record<
|