docs: update @apify/docusaurus-plugin-typedoc-api (#713)

Updating the plugin allows us to use the new unified transformation
pipeline instead of handling the API docs generation separately in each
Python project.

The new version also now renders the Typedoc objects in machine-readable
elements on the page, so we can use the new `reexports` plugin option
(more about that in a PR in `apify-sdk-python`).

Author: barjin

Makefile

@@ -49,7 +49,7 @@ build-api-reference:
 	cd website && poetry run ./build_api_reference.sh
 
 build-docs:
-	cd website && corepack enable && yarn && yarn build
+	cd website && corepack enable && yarn && poetry run yarn build
 
 run-docs: build-api-reference
-	cd website && corepack enable && yarn && yarn start
+	cd website && corepack enable && yarn && poetry run yarn start

website/build_api_reference.sh

@@ -1,12 +1,4 @@
 #!/bin/bash
 
-# Create docspec dump of this package's source code through pydoc-markdown
-python ./pydoc-markdown/generate_ast.py > docspec-dump.jsonl
-
-rm -rf "${apify_shared_tempdir}"
-
 # Generate import shortcuts from the modules
 python generate_module_shortcuts.py
-
-# Transform the docpec dumps into Typedoc-compatible docs tree
-node transformDocs.js

website/docusaurus.config.js

@@ -1,6 +1,27 @@
-/* eslint-disable global-require,import/no-extraneous-dependencies */
+/* eslint-disable global-require */
+const path = require('path');
+
 const { externalLinkProcessor } = require('./tools/utils/externalLink');
-const { groupSort } = require('./transformDocs');
+
+const GROUP_ORDER = [
+    'Classes',
+    'Abstract classes',
+    'Data structures',
+    'Errors',
+    'Functions',
+    'Constructors',
+    'Methods',
+    'Properties',
+    'Constants',
+    'Enumeration Members',
+];
+
+const groupSort = (g1, g2) => {
+    if (GROUP_ORDER.includes(g1) && GROUP_ORDER.includes(g2)) {
+        return GROUP_ORDER.indexOf(g1) - GROUP_ORDER.indexOf(g2);
+    }
+    return g1.localeCompare(g2);
+};
 
 /** @type {Partial<import('@docusaurus/types').DocusaurusConfig>} */
 module.exports = {
@@ -14,6 +35,7 @@ module.exports = {
         '/python/js/custom.js',
         '/crawlee-python/js/custom.js',
     ],
+    githubHost: 'github.com',
     headTags: [
         // Intercom messenger
         {
@@ -78,9 +100,11 @@ module.exports = {
                     excludeExternals: false,
                 },
                 sortSidebar: groupSort,
-                pathToCurrentVersionTypedocJSON: `${__dirname}/api-typedoc-generated.json`,
                 routeBasePath: 'api',
-                python: true,
+                pythonOptions: {
+                    pythonModulePath: path.join(__dirname, '../src/crawlee'),
+                    moduleShortcutsPath: path.join(__dirname, 'module_shortcuts.json'),
+                },
             },
         ],
         // [

website/package.json

@@ -34,7 +34,7 @@
         "typescript": "5.6.3"
     },
     "dependencies": {
-        "@apify/docusaurus-plugin-typedoc-api": "^4.2.7",
+        "@apify/docusaurus-plugin-typedoc-api": "^4.3.0",
         "@apify/utilities": "^2.8.0",
         "@docusaurus/core": "^3.5.2",
         "@docusaurus/mdx-loader": "^3.5.2",