@apify/docusaurus-plugin-typedoc-api 4.2.10 → 4.2.11-1

package/src/components/SourceLink.tsx

@@ -1,4 +1,5 @@
 import type { JSONOutput } from 'typedoc';
+import type { DocusaurusConfig } from '@docusaurus/types';
 import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
 import { useGitRefName } from '../hooks/useGitRefName';
 
@@ -11,6 +12,10 @@ export interface SourceLinkProps {
 	sources?: JSONOutput.SourceReference[];
 }
 
+export function resolveGithubUrl(source: JSONOutput.SourceReference, siteConfig: DocusaurusConfig, gitRefName: string): string {
+	return source.url || `https://${siteConfig.githubHost}${siteConfig.githubPort ? `:${siteConfig.githubPort}` : ''}/${siteConfig.organizationName}/${siteConfig.projectName}/blob/${gitRefName}/${replaceWithSrc(source.fileName)}#L${source.line}`;
+}
+
 export function SourceLink({ sources = [] }: SourceLinkProps) {
 	const { siteConfig } = useDocusaurusContext();
 	const gitRefName = useGitRefName();
@@ -25,14 +30,7 @@ export function SourceLink({ sources = [] }: SourceLinkProps) {
 				<a
 					key={source.fileName}
 					className="tsd-anchor"
-					href={
-						source.url ||
-						`https://${siteConfig.githubHost}${
-							siteConfig.githubPort ? `:${siteConfig.githubPort}` : ''
-						}/${siteConfig.organizationName}/${
-							siteConfig.projectName
-						}/blob/${gitRefName}/${replaceWithSrc(source.fileName)}#L${source.line}`
-					}
+					href={resolveGithubUrl(source, siteConfig, gitRefName)}
 					rel="noreferrer"
 					target="_blank"
 				>

package/src/components/Type.tsx

@@ -39,7 +39,6 @@ export interface TypeProps {
 	type?: { type: string; value?: unknown };
 }
 
-// eslint-disable-next-line complexity
 export function Type({ needsParens = false, type: base }: TypeProps) {
 	const reflections = useReflectionMap();
 	const { isPython } = usePluginData('docusaurus-plugin-typedoc-api') as GlobalData;
@@ -135,7 +134,8 @@ export function Type({ needsParens = false, type: base }: TypeProps) {
 		case 'literal': {
 			const type = base as JSONOutput.LiteralType;
 
-			if (isPython && type.value === null) {
+			if (isPython && (type.value === null 
+					|| (typeof type.value === 'object' && Object.keys(type.value).length === 0))) {
 				return <span className="tsd-signature-type">None</span>;
 			}
 
@@ -217,10 +217,10 @@ export function Type({ needsParens = false, type: base }: TypeProps) {
 		}
 
 		case 'reference': {
-			const type = base as JSONOutput.ReferenceType;
+			const type = base as JSONOutput.ReferenceType & { ref?: TSDDeclarationReflection };
 			// eslint-disable-next-line
 			const reflectionIdentifier = type.target ?? (type as any).id;
-			const ref = reflectionIdentifier ? reflections[Number(reflectionIdentifier)] : null;
+			const ref = type.ref ?? (reflectionIdentifier ? reflections[Number(reflectionIdentifier)] : null);
 			const genericClass = ref?.id && !ref.sources ? 'tsd-signature-type-generic' : '';
 
 			return (
@@ -238,22 +238,14 @@ export function Type({ needsParens = false, type: base }: TypeProps) {
 					)}
 					{type.typeArguments && type.typeArguments.length > 0 && (
 						<>
-							<span className="tsd-signature-symbol">
-								{
-									isPython ? '[' : '<'
-								}
-							</span>
+							<span className="tsd-signature-symbol">{isPython ? '[' : '<'}</span>
 							{type.typeArguments.map((t, i) => (
 								<Fragment key={t.type + i}>
 									{i > 0 && <span className="tsd-signature-symbol">, </span>}
 									<Type type={t} />
 								</Fragment>
 							))}
-							<span className="tsd-signature-symbol">
-								{
-									isPython ? ']' : '>'
-								}
-							</span>
+							<span className="tsd-signature-symbol">{isPython ? ']' : '>'}</span>
 						</>
 					)}
 				</>

package/src/components/VersionBanner.tsx

@@ -1,6 +1,10 @@
 import { useCallback } from 'react';
 import Link from '@docusaurus/Link';
-import { useDocsPreferredVersion, useDocsVersion, useDocVersionSuggestions } from '@docusaurus/plugin-content-docs/client';
+import {
+	useDocsPreferredVersion,
+	useDocsVersion,
+	useDocVersionSuggestions,
+} from '@docusaurus/plugin-content-docs/client';
 import { ThemeClassNames } from '@docusaurus/theme-common';
 
 export function VersionBanner(): JSX.Element | null {

package/src/index.ts

@@ -13,6 +13,7 @@ import {
 	generateJson,
 	loadPackageJsonAndDocs,
 } from './plugin/data';
+import { processPythonDocs } from './plugin/python';
 import { extractSidebar } from './plugin/sidebar';
 import { getVersionedDocsDirPath, readVersionsMetadata } from './plugin/version';
 import type {
@@ -26,6 +27,7 @@ import type {
 	TSDDeclarationReflection,
 	VersionMetadata,
 } from './types';
+import { injectReexports } from './utils/reexports';
 
 const DEFAULT_OPTIONS: Required<DocusaurusPluginTypeDocApiOptions> = {
 	banner: '',
@@ -57,6 +59,8 @@ const DEFAULT_OPTIONS: Required<DocusaurusPluginTypeDocApiOptions> = {
 	rehypePlugins: [],
 	versions: {},
 	python: false,
+	pythonOptions: {},
+	reexports: [],
 };
 
 async function importFile<T>(file: string): Promise<T> {
@@ -167,9 +171,8 @@ export default function typedocApiPlugin(
 							options.changelogName,
 						);
 
-						// eslint-disable-next-line no-param-reassign
 						cfg.packageName = packageJson.name;
-						// eslint-disable-next-line no-param-reassign
+
 						cfg.packageVersion = packageJson.version;
 					});
 
@@ -195,15 +198,33 @@ export default function typedocApiPlugin(
 						if (metadata.versionName === CURRENT_VERSION_NAME) {
 							const outFile = path.join(context.generatedFilesDir, `api-typedoc-${pluginId}.json`);
 
+							if (!fs.existsSync(context.generatedFilesDir)) {
+								fs.mkdirSync(context.generatedFilesDir, { recursive: true });
+							}
+
 							if (options.pathToCurrentVersionTypedocJSON) {
-								if (!fs.existsSync(context.generatedFilesDir)){
-									fs.mkdirSync(context.generatedFilesDir, { recursive: true });
-								}
 								fs.copyFileSync(options.pathToCurrentVersionTypedocJSON, outFile);
+							} else if (Object.keys(options.pythonOptions).length > 0) {
+								if (
+									!options.pythonOptions.pythonModulePath ||
+									!options.pythonOptions.moduleShortcutsPath
+								) {
+									throw new Error('Python options are missing required fields');
+								}
+
+								processPythonDocs({
+									pythonModulePath: options.pythonOptions.pythonModulePath,
+									moduleShortcutsPath: options.pythonOptions.moduleShortcutsPath,
+									outPath: outFile,
+								});
 							} else {
 								await generateJson(projectRoot, entryPoints, outFile, options);
 							}
 
+							if (options.reexports && options.reexports.length > 0) {
+								await injectReexports(outFile, options.reexports);
+							}
+
 							packages = flattenAndGroupPackages(
 								packageConfigs,
 								await importFile(outFile),
@@ -266,7 +287,7 @@ export default function typedocApiPlugin(
 			}
 
 			actions.setGlobalData({
-				isPython: !!options.python,
+				isPython: !!(options.python || options.pythonOptions),
 			} as GlobalData);
 
 			const docs: PropVersionDocs = {};
@@ -330,7 +351,10 @@ export default function typedocApiPlugin(
 						return {
 							path: info.permalink,
 							exact: true,
-							component: path.join(__dirname, `./components/ApiItem.${process.env.TYPEDOC_PLUGIN_DEV ? 'tsx' : 'js'}`),
+							component: path.join(
+								__dirname,
+								`./components/ApiItem.${process.env.TYPEDOC_PLUGIN_DEV ? 'tsx' : 'js'}`,
+							),
 							modules,
 							sidebar: 'api',
 							// Map the ID here instead of creating a JSON data file,
@@ -399,7 +423,10 @@ export default function typedocApiPlugin(
 							{
 								path: indexPermalink,
 								exact: false,
-								component: path.join(__dirname, `./components/ApiPage.${process.env.TYPEDOC_PLUGIN_DEV ? 'tsx' : 'js'}`),
+								component: path.join(
+									__dirname,
+									`./components/ApiPage.${process.env.TYPEDOC_PLUGIN_DEV ? 'tsx' : 'js'}`,
+								),
 								routes,
 								modules: {
 									options: optionsData,
@@ -463,7 +490,10 @@ export default function typedocApiPlugin(
 										remarkPlugins: options.remarkPlugins,
 										rehypePlugins: options.rehypePlugins,
 										siteDir: context.siteDir,
-										staticDirs: [...context.siteConfig.staticDirectories, path.join(context.siteDir, 'static')],
+										staticDirs: [
+											...context.siteConfig.staticDirectories,
+											path.join(context.siteDir, 'static'),
+										],
 										// Since this isn't a doc/blog page, we can get
 										// away with it being a partial!
 										isMDXPartial: () => true,

package/src/plugin/data.ts

@@ -1,7 +1,7 @@
 import fs from 'fs';
 import path from 'path';
 import * as TypeDoc from 'typedoc';
-import { type InlineTagDisplayPart, type JSONOutput, ReflectionKind } from 'typedoc'
+import { type InlineTagDisplayPart, type JSONOutput, ReflectionKind } from 'typedoc';
 import ts from 'typescript';
 import { normalizeUrl } from '@docusaurus/utils';
 import type {
@@ -110,7 +110,6 @@ export function createReflectionMap(
 ): TSDDeclarationReflectionMap {
 	const map: TSDDeclarationReflectionMap = {};
 
-	// eslint-disable-next-line complexity
 	items.forEach((item) => {
 		// Add @reference categories to reflection.
 		const referenceCategories: Record<string, { title: string; children: number[] }> = {};
@@ -133,7 +132,6 @@ export function createReflectionMap(
 
 		// Update categories with reference categories.
 		if (!item.categories) {
-			// eslint-disable-next-line no-param-reassign
 			item.categories = [];
 		}
 		for (const category of Object.values(referenceCategories)) {
@@ -170,7 +168,7 @@ export function loadPackageJsonAndDocs(
 		}
 	}
 
-	if(!found) {
+	if (!found) {
 		// TODO: load the actual package information from pyproject.toml or similar
 		return {
 			packageJson: {
@@ -179,7 +177,7 @@ export function loadPackageJsonAndDocs(
 			},
 			readmePath: '',
 			changelogPath: '',
-		}
+		};
 	}
 
 	const readmePath = path.join(currentDir, readmeFileName);
@@ -203,7 +201,6 @@ export function addMetadataToReflections(
 	const permalink = `/${joinUrl(urlPrefix, packageSlug)}`;
 
 	if (project.children) {
-		// eslint-disable-next-line no-param-reassign
 		project.children = project.children.map((child) => {
 			migrateToVersion0230(child);
 
@@ -213,7 +210,6 @@ export function addMetadataToReflections(
 
 			// We need to go another level deeper and only use fragments
 			if (child.kind === ReflectionKind.Namespace && child.children) {
-				// eslint-disable-next-line no-param-reassign
 				child.children = child.children.map((grandChild) => ({
 					...grandChild,
 					permalink: normalizeUrl([`${childPermalink}#${grandChild.name}`]),
@@ -251,7 +247,7 @@ function mergeReflections(base: TSDDeclarationReflection, next: TSDDeclarationRe
 		});
 
 		// We can remove refs since were merging all reflections into one
-		// eslint-disable-next-line no-param-reassign
+
 		base.groups = base.groups.filter((group) => group.title !== 'References');
 	}
 }
@@ -390,14 +386,13 @@ function buildSourceFileNameMap(
 	const map: Record<string, boolean> = {};
 	const cwd = process.cwd();
 
-	if(project.symbolIdMap) {
+	if (project.symbolIdMap) {
 		Object.values(project.symbolIdMap).forEach((symbol) => {
 			// absolute
 			map[path.normalize(path.join(cwd, symbol.sourceFileName))] = true;
 		});
 	}
 
-
 	modChildren.forEach((child) => {
 		child.sources?.forEach((sf) => {
 			// relative
@@ -458,9 +453,8 @@ export function flattenAndGroupPackages(
 						changelogPath,
 					};
 
-					// eslint-disable-next-line no-param-reassign
 					cfg.packageName = packages[cfg.packagePath].packageName;
-					// eslint-disable-next-line no-param-reassign
+
 					cfg.packageVersion = packages[cfg.packagePath].packageVersion;
 				}
 

package/src/plugin/python/consts.ts

@@ -0,0 +1,50 @@
+export const REPO_ROOT_PLACEHOLDER = 'REPO_ROOT_PLACEHOLDER';
+
+export const APIFY_CLIENT_REPO_URL = 'https://github.com/apify/apify-client-python';
+export const APIFY_SDK_REPO_URL = 'https://github.com/apify/apify-sdk-python';
+export const APIFY_SHARED_REPO_URL = 'https://github.com/apify/apify-shared-python';
+export const CRAWLEE_PYTHON_REPO_URL = 'https://github.com/apify/crawlee-python';
+
+export const REPO_URL_PER_PACKAGE = {
+	apify: APIFY_SDK_REPO_URL,
+	apify_client: APIFY_CLIENT_REPO_URL,
+	apify_shared: APIFY_SHARED_REPO_URL,
+	crawlee: CRAWLEE_PYTHON_REPO_URL,
+};
+
+// Taken from https://github.com/TypeStrong/typedoc/blob/v0.23.24/src/lib/models/reflections/kind.ts, modified
+export const TYPEDOC_KINDS = {
+	class: {
+		kind: 128,
+		kindString: 'Class',
+	},
+	data: {
+		kind: 1024,
+		kindString: 'Property',
+	},
+	enum: {
+		kind: 8,
+		kindString: 'Enumeration',
+	},
+	enumValue: {
+		kind: 16,
+		kindString: 'Enumeration Member',
+	},
+	function: {
+		kind: 2048,
+		kindString: 'Method',
+	},
+};
+
+export const GROUP_ORDER = [
+	'Classes',
+	'Abstract classes',
+	'Data structures',
+	'Errors',
+	'Functions',
+	'Constructors',
+	'Methods',
+	'Properties',
+	'Constants',
+	'Enumeration Members',
+];

package/src/plugin/python/docspec-gen/generate_ast.py

@@ -0,0 +1,73 @@
+"""
+Replaces the default pydoc-markdown shell script with a custom Python script calling the pydoc-markdown API directly.
+
+This script generates an AST from the Python source code in the `src` directory and prints it as a JSON object.
+"""
+
+from pydoc_markdown.interfaces import Context
+from pydoc_markdown.contrib.loaders.python import PythonLoader
+from pydoc_markdown.contrib.processors.filter import FilterProcessor
+from pydoc_markdown.contrib.processors.crossref import CrossrefProcessor
+from google_docstring_processor import ApifyGoogleProcessor
+from docspec import dump_module
+
+import argparse
+
+import json
+import os
+
+def search_for_git_root(path):
+    if os.path.exists(os.path.join(path, '.git')):
+        return path
+    else:
+        parent = os.path.dirname(path)
+        if parent == path:
+            return None
+        return search_for_git_root(parent)
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument("-i", "--input", help = "Path to the Python module to generate the AST from.", required=True)
+    parser.add_argument("output", help = "Path to store the generated AST as a JSON file in.")
+
+    args = parser.parse_args()
+    project_path = os.path.abspath(args.input)
+
+    repo_root_path = search_for_git_root(project_path)
+    if not repo_root_path:
+        raise Exception("Could not find git root directory. Are you sure the Python module is in a git repository?")
+
+    context = Context(directory='.')
+    loader = PythonLoader(search_path=[project_path])
+    filter = FilterProcessor(
+        documented_only=False,
+        skip_empty_modules=False,
+    )
+    crossref = CrossrefProcessor()
+    google = ApifyGoogleProcessor()
+
+    loader.init(context)
+    filter.init(context)
+    google.init(context)
+    crossref.init(context)
+
+    processors = [filter, google, crossref]
+
+    dump = []
+
+    modules = list(loader.load())
+
+    for processor in processors:
+        processor.process(modules, None)
+
+    for module in modules:
+        dump.append(dump_module(module))
+
+    with open(args.output, 'w') as f:
+        f.write(json.dumps(dump, indent=4).replace(
+            repo_root_path,
+            'REPO_ROOT_PLACEHOLDER'
+        ))
+
+if __name__ == "__main__":
+    main()

package/src/plugin/python/docspec-gen/google_docstring_processor.py

@@ -0,0 +1,185 @@
+# -*- coding: utf8 -*-
+# Copyright (c) 2019 Niklas Rosenstein
+# !!! Modified 2024 Jindřich Bär
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to
+# deal in the Software without restriction, including without limitation the
+# rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+# sell copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
+# IN THE SOFTWARE.
+
+import dataclasses
+import re
+import typing as t
+
+import docspec
+
+from pydoc_markdown.contrib.processors.sphinx import generate_sections_markdown
+from pydoc_markdown.interfaces import Processor, Resolver
+
+import json
+
+
+@dataclasses.dataclass
+class ApifyGoogleProcessor(Processor):
+    """
+    This class implements the preprocessor for Google and PEP 257 docstrings. It converts
+    docstrings formatted in the Google docstyle to Markdown syntax.
+
+    References:
+
+    * https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html
+    * https://www.python.org/dev/peps/pep-0257/
+
+    Example:
+
+    ```
+    Attributes:
+        module_level_variable1 (int): Module level variables may be documented in
+            either the ``Attributes`` section of the module docstring, or in an
+            inline docstring immediately following the variable.
+
+            Either form is acceptable, but the two should not be mixed. Choose
+            one convention to document module level variables and be consistent
+            with it.
+
+    Todo:
+        * For module TODOs
+        * You have to also use ``sphinx.ext.todo`` extension
+    ```
+
+    Renders as:
+
+    Attributes:
+        module_level_variable1 (int): Module level variables may be documented in
+            either the ``Attributes`` section of the module docstring, or in an
+            inline docstring immediately following the variable.
+
+            Either form is acceptable, but the two should not be mixed. Choose
+            one convention to document module level variables and be consistent
+            with it.
+
+    Todo:
+        * For module TODOs
+        * You have to also use ``sphinx.ext.todo`` extension
+
+    @doc:fmt:google
+    """
+
+    _param_res = [
+        re.compile(r"^(?P<param>\S+):\s+(?P<desc>.+)$"),
+        re.compile(r"^(?P<param>\S+)\s+\((?P<type>[^)]+)\):\s+(?P<desc>.+)$"),
+        re.compile(r"^(?P<param>\S+)\s+--\s+(?P<desc>.+)$"),
+        re.compile(r"^(?P<param>\S+)\s+\{\[(?P<type>\S+)\]\}\s+--\s+(?P<desc>.+)$"),
+        re.compile(r"^(?P<param>\S+)\s+\{(?P<type>\S+)\}\s+--\s+(?P<desc>.+)$"),
+    ]
+
+    _keywords_map = {
+        "Args:": "Arguments",
+        "Arguments:": "Arguments",
+        "Attributes:": "Attributes",
+        "Example:": "Example",
+        "Examples:": "Examples",
+        "Keyword Args:": "Arguments",
+        "Keyword Arguments:": "Arguments",
+        "Methods:": "Methods",
+        "Note:": "Notes",
+        "Notes:": "Notes",
+        "Other Parameters:": "Arguments",
+        "Parameters:": "Arguments",
+        "Return:": "Returns",
+        "Returns:": "Returns",
+        "Raises:": "Raises",
+        "References:": "References",
+        "See Also:": "See Also",
+        "Todo:": "Todo",
+        "Warning:": "Warnings",
+        "Warnings:": "Warnings",
+        "Warns:": "Warns",
+        "Yield:": "Yields",
+        "Yields:": "Yields",
+    }
+
+    def check_docstring_format(self, docstring: str) -> bool:
+        for section_name in self._keywords_map:
+            if section_name in docstring:
+                return True
+        return False
+
+    def process(self, modules: t.List[docspec.Module], resolver: t.Optional[Resolver]) -> None:
+        docspec.visit(modules, self._process)
+
+    def _process(self, node: docspec.ApiObject):
+        if not node.docstring:
+            return
+
+        lines = []
+        sections = []
+        current_lines: t.List[str] = []
+        in_codeblock = False
+        keyword = None
+        multiline_argument_offset = -1
+
+        def _commit():
+            if keyword:
+                sections.append({keyword: list(current_lines)})
+            else:
+                lines.extend(current_lines)
+            current_lines.clear()
+
+        for line in node.docstring.content.split("\n"):
+            multiline_argument_offset += 1
+            if line.lstrip().startswith("```"):
+                in_codeblock = not in_codeblock
+                current_lines.append(line)
+                if not in_codeblock:
+                    _commit()
+                continue
+
+            if in_codeblock:
+                current_lines.append(line)
+                continue
+
+            line = line.strip()
+            if line in self._keywords_map:
+                _commit()
+                keyword = self._keywords_map[line]
+                continue
+
+            if keyword is None:
+                lines.append(line)
+                continue
+
+            for param_re in self._param_res:
+                param_match = param_re.match(line)
+                if param_match:
+                    current_lines.append(param_match.groupdict())
+                    multiline_argument_offset = 0
+                    break
+
+            if not param_match:
+                if multiline_argument_offset == 1:
+                    current_lines[-1]["desc"] += "\n" + line
+                    multiline_argument_offset = 0
+                else:
+                    current_lines.append(line)
+
+        _commit()
+        node.docstring.content = json.dumps({
+            "text": "\n".join(lines),
+            "sections": sections,
+        }, indent=None)
+        
+

package/src/plugin/python/index.ts

@@ -0,0 +1,47 @@
+import childProcess from 'child_process';
+import fs from 'fs';
+import path from 'path';
+import { DocspecTransformer } from './transformation';
+import type { DocspecObject } from './types';
+
+export { groupSort } from './utils';
+
+/**
+ * Processes the Python documentation generated by `pydoc-markdown` and transforms it into a format
+ * accepted by the TypeDoc JSON generator.
+ */
+export function processPythonDocs({
+	pythonModulePath,
+	moduleShortcutsPath,
+	outPath,
+}: {
+	pythonModulePath: string;
+	moduleShortcutsPath: string;
+	outPath: string;
+}) {
+	const pydocMarkdownDumpPath = path.join(__dirname, './pydoc-markdown-dump.json');
+
+	childProcess.spawnSync('python', [
+		path.join(__dirname, './docspec-gen/generate_ast.py'),
+		'-i',
+		pythonModulePath,
+		pydocMarkdownDumpPath,
+	]);
+
+	const moduleShortcuts = JSON.parse(fs.readFileSync(moduleShortcutsPath, 'utf8')) as Record<
+		string,
+		string
+	>;
+
+	const pydocMarkdownDump = JSON.parse(
+		fs.readFileSync(pydocMarkdownDumpPath, 'utf8'),
+	) as DocspecObject[];
+
+	const docspecTransformer = new DocspecTransformer({
+		moduleShortcuts,
+	});
+
+	const typedocApiReference = docspecTransformer.transform(pydocMarkdownDump);
+
+	fs.writeFileSync(outPath, JSON.stringify(typedocApiReference, null, 4));
+}