@apify/docusaurus-plugin-typedoc-api 4.3.4 → 4.3.6
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.
|
@@ -37,7 +37,7 @@ function getGroupName(object) {
|
|
|
37
37
|
const groupPredicates = {
|
|
38
38
|
'Scrapy integration': x => ['ApifyScheduler', 'ActorDatasetPushPipeline', 'ApifyHttpProxyMiddleware', 'apply_apify_settings'].includes(x.name),
|
|
39
39
|
'Data structures': x => Boolean(['BaseModel', 'TypedDict'].some(base => x?.bases?.includes(base)) || x?.decorations?.some(d => d.name === 'dataclass')),
|
|
40
|
-
Errors: x => x.name.toLowerCase().
|
|
40
|
+
Errors: x => x.name.toLowerCase().endsWith('error') && x.kindString === 'Class',
|
|
41
41
|
Classes: x => x.kindString === 'Class',
|
|
42
42
|
'Main Clients': x => ['ApifyClient', 'ApifyClientAsync'].includes(x.name),
|
|
43
43
|
'Async Resource Clients': x => x.name.toLowerCase().includes('async'),
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"utils.js","sources":["../../../src/plugin/python/utils.ts"],"sourcesContent":null,"names":["TYPEDOC_KINDS","GROUP_ORDER"],"mappings":";;;;AAAA;AAEA,UAAU,WAAW,GAAG;AACxB,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;AACb,EAAE,OAAO,IAAI,EAAE;AACf,IAAI,MAAM,EAAE,EAAE,CAAC;AACf,GAAG;AACH,CAAC;AACD,MAAM,YAAY,GAAG,WAAW,EAAE,CAAC;AACnC;AACA;AACA;AACA;AACA;AACO,SAAS,MAAM,GAAG;AACzB,EAAE,OAAO,YAAY,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;AACnC,CAAC;AACD;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,YAAY,CAAC,MAAM,EAAE;AACrC,EAAE,IAAI,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,EAAE;AAC9D,IAAI,MAAM,eAAe,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACrG,IAAI,IAAI,eAAe,EAAE;AACzB,MAAM,OAAO;AACb,QAAQ,SAAS,EAAE,eAAe;AAClC,QAAQ,MAAM,EAAE,WAAW;AAC3B,OAAO,CAAC;AACR,KAAK;AACL,GAAG;AACH,EAAE,MAAM,eAAe,GAAG;AAC1B,IAAI,oBAAoB,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,0BAA0B,EAAE,0BAA0B,EAAE,sBAAsB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;AAClJ,IAAI,iBAAiB,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC;AAC3J,IAAI,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC;
|
|
1
|
+
{"version":3,"file":"utils.js","sources":["../../../src/plugin/python/utils.ts"],"sourcesContent":null,"names":["TYPEDOC_KINDS","GROUP_ORDER"],"mappings":";;;;AAAA;AAEA,UAAU,WAAW,GAAG;AACxB,EAAE,IAAI,EAAE,GAAG,CAAC,CAAC;AACb,EAAE,OAAO,IAAI,EAAE;AACf,IAAI,MAAM,EAAE,EAAE,CAAC;AACf,GAAG;AACH,CAAC;AACD,MAAM,YAAY,GAAG,WAAW,EAAE,CAAC;AACnC;AACA;AACA;AACA;AACA;AACO,SAAS,MAAM,GAAG;AACzB,EAAE,OAAO,YAAY,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC;AACnC,CAAC;AACD;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,YAAY,CAAC,MAAM,EAAE;AACrC,EAAE,IAAI,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,EAAE;AAC9D,IAAI,MAAM,eAAe,GAAG,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AACrG,IAAI,IAAI,eAAe,EAAE;AACzB,MAAM,OAAO;AACb,QAAQ,SAAS,EAAE,eAAe;AAClC,QAAQ,MAAM,EAAE,WAAW;AAC3B,OAAO,CAAC;AACR,KAAK;AACL,GAAG;AACH,EAAE,MAAM,eAAe,GAAG;AAC1B,IAAI,oBAAoB,EAAE,CAAC,IAAI,CAAC,gBAAgB,EAAE,0BAA0B,EAAE,0BAA0B,EAAE,sBAAsB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;AAClJ,IAAI,iBAAiB,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC;AAC3J,IAAI,MAAM,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,UAAU,KAAK,OAAO;AACnF,IAAI,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,KAAK,OAAO;AAC1C,IAAI,cAAc,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;AAC7E,IAAI,wBAAwB,EAAE,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC;AACzE,IAAI,kBAAkB,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,KAAK,OAAO,IAAI,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC;AAChG,IAAI,OAAO,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,KAAK,QAAQ;AAC3C,IAAI,YAAY,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,KAAK,aAAa;AACrD,IAAI,UAAU,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,KAAK,UAAU;AAChD,IAAI,SAAS,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,KAAK,aAAa;AAClD,IAAI,qBAAqB,EAAE,CAAC,IAAI,CAAC,CAAC,UAAU,KAAK,oBAAoB;AACrE,GAAG,CAAC;AACJ,EAAE,MAAM,SAAS,GAAG,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,KAAK,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;AACrG,EAAE,OAAO;AACT,IAAI,SAAS;AACb,IAAI,MAAM,EAAE,WAAW;AACvB,GAAG,CAAC;AACJ,CAAC;AACD;AACA;AACA;AACA;AACA;AACO,SAAS,6BAA6B,CAAC,MAAM,EAAE;AACtD,EAAE,IAAI,MAAM,YAAY,MAAM,EAAE;AAChC,IAAI,IAAI,MAAM,CAAC,IAAI,KAAK,YAAY,EAAE;AACtC,MAAM,OAAO,IAAI,CAAC;AAClB,KAAK;AACL,IAAI,KAAK,MAAM,GAAG,IAAI,MAAM,EAAE;AAC9B,MAAM,IAAI,6BAA6B,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE;AACtD,QAAQ,OAAO,IAAI,CAAC;AACpB,OAAO;AACP,KAAK;AACL,GAAG;AACH,EAAE,OAAO,KAAK,CAAC;AACf,CAAC;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,QAAQ,CAAC,MAAM,EAAE;AACjC,EAAE,OAAO,EAAE,MAAM,CAAC,IAAI,IAAIA,oBAAa,CAAC,IAAI,MAAM,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,aAAa,CAAC,IAAI,MAAM,CAAC,IAAI,KAAK,aAAa,CAAC;AACrI,CAAC;AACD;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,SAAS,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE;AAClC,EAAE,IAAIC,kBAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAIA,kBAAW,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE;AAC5D,IAAI,OAAOA,kBAAW,CAAC,OAAO,CAAC,EAAE,CAAC,GAAGA,kBAAW,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;AAC7D,GAAG;AACH,EAAE,OAAO,EAAE,CAAC,aAAa,CAAC,EAAE,CAAC,CAAC;AAC9B,CAAC;AACD;AACA;AACA;AACA;AACO,SAAS,YAAY,CAAC,aAAa,EAAE;AAC5C,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO;AACpC,EAAE,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,MAAM,EAAE;AAC5C,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK;AAClC,MAAM,MAAM,SAAS,GAAG,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,MAAM,KAAK,CAAC,CAAC,EAAE,IAAI,IAAI,GAAG,CAAC;AACpH,MAAM,MAAM,UAAU,GAAG,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,MAAM,KAAK,CAAC,CAAC,EAAE,IAAI,IAAI,GAAG,CAAC;AACrH,MAAM,OAAO,SAAS,CAAC,aAAa,CAAC,UAAU,CAAC,CAAC;AACjD,KAAK,CAAC,CAAC;AACP,GAAG;AACH,EAAE,aAAa,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;AACpE;;;;;;;;;"}
|
package/package.json
CHANGED
|
@@ -121,6 +121,9 @@ class ApifyGoogleProcessor(Processor):
|
|
|
121
121
|
def process(self, modules: t.List[docspec.Module], resolver: t.Optional[Resolver]) -> None:
|
|
122
122
|
docspec.visit(modules, self._process)
|
|
123
123
|
|
|
124
|
+
def get_indent_size(self, line: str) -> int:
|
|
125
|
+
return len(line) - len(line.lstrip())
|
|
126
|
+
|
|
124
127
|
def _process(self, node: docspec.ApiObject):
|
|
125
128
|
if not node.docstring:
|
|
126
129
|
return
|
|
@@ -131,6 +134,7 @@ class ApifyGoogleProcessor(Processor):
|
|
|
131
134
|
in_codeblock = False
|
|
132
135
|
keyword = None
|
|
133
136
|
multiline_argument_offset = -1
|
|
137
|
+
state = { 'param_indent': None }
|
|
134
138
|
|
|
135
139
|
def _commit():
|
|
136
140
|
if keyword:
|
|
@@ -139,6 +143,13 @@ class ApifyGoogleProcessor(Processor):
|
|
|
139
143
|
lines.extend(current_lines)
|
|
140
144
|
current_lines.clear()
|
|
141
145
|
|
|
146
|
+
def is_continuation(line: str) -> bool:
|
|
147
|
+
if state.get('param_indent') is None:
|
|
148
|
+
state['param_indent'] = self.get_indent_size(line)
|
|
149
|
+
return False
|
|
150
|
+
|
|
151
|
+
return self.get_indent_size(line) > state.get('param_indent')
|
|
152
|
+
|
|
142
153
|
for line in node.docstring.content.split("\n"):
|
|
143
154
|
multiline_argument_offset += 1
|
|
144
155
|
if line.lstrip().startswith("```"):
|
|
@@ -152,29 +163,29 @@ class ApifyGoogleProcessor(Processor):
|
|
|
152
163
|
current_lines.append(line)
|
|
153
164
|
continue
|
|
154
165
|
|
|
155
|
-
|
|
156
|
-
if
|
|
166
|
+
stripped = line.strip()
|
|
167
|
+
if stripped in self._keywords_map:
|
|
157
168
|
_commit()
|
|
158
|
-
keyword = self._keywords_map[
|
|
169
|
+
keyword = self._keywords_map[stripped]
|
|
159
170
|
continue
|
|
160
171
|
|
|
161
172
|
if keyword is None:
|
|
162
|
-
lines.append(
|
|
173
|
+
lines.append(stripped)
|
|
163
174
|
continue
|
|
164
175
|
|
|
165
176
|
for param_re in self._param_res:
|
|
166
|
-
param_match = param_re.match(
|
|
167
|
-
if param_match:
|
|
177
|
+
param_match = param_re.match(stripped)
|
|
178
|
+
if param_match and not is_continuation(line):
|
|
168
179
|
current_lines.append(param_match.groupdict())
|
|
169
180
|
multiline_argument_offset = 0
|
|
170
181
|
break
|
|
171
182
|
|
|
172
183
|
if not param_match:
|
|
173
184
|
if multiline_argument_offset == 1:
|
|
174
|
-
current_lines[-1]["desc"] += "\n" +
|
|
185
|
+
current_lines[-1]["desc"] += "\n" + stripped
|
|
175
186
|
multiline_argument_offset = 0
|
|
176
187
|
else:
|
|
177
|
-
current_lines.append(
|
|
188
|
+
current_lines.append(stripped)
|
|
178
189
|
|
|
179
190
|
_commit()
|
|
180
191
|
node.docstring.content = json.dumps({
|
|
@@ -53,7 +53,7 @@ export function getGroupName(object: TypeDocObject): {
|
|
|
53
53
|
Boolean(['BaseModel', 'TypedDict'].some((base) =>
|
|
54
54
|
(x?.bases as { includes: (x: string) => boolean })?.includes(base),
|
|
55
55
|
) || x?.decorations?.some((d) => d.name === 'dataclass')),
|
|
56
|
-
Errors: (x) => x.name.toLowerCase().
|
|
56
|
+
Errors: (x) => x.name.toLowerCase().endsWith('error') && x.kindString === 'Class',
|
|
57
57
|
Classes: (x) => x.kindString === 'Class',
|
|
58
58
|
'Main Clients': (x) => ['ApifyClient', 'ApifyClientAsync'].includes(x.name),
|
|
59
59
|
'Async Resource Clients': (x) => x.name.toLowerCase().includes('async'),
|