Generate TypeDoc for @solana/web3.js 2.0 (#3500)

Author: steveluscher

.github/workflows/publish-gh-pages.yml

@@ -38,8 +38,8 @@ jobs:
 
       - name: Assemble Deploy Directory
         run: |
-          mkdir -p .ghpages-deploy
-          mv ./doc/* .ghpages-deploy
+          mkdir -p .ghpages-deploy/v1.x
+          mv ./doc/* .ghpages-deploy/v1.x
 
       - uses: actions/upload-artifact@v4
         with:
@@ -66,6 +66,7 @@ jobs:
         run: |
           mkdir -p .ghpages-deploy
           mv ./examples/react-app/dist/ .ghpages-deploy/example/
+          mv ./docs/* .ghpages-deploy/
 
       - uses: actions/upload-artifact@v4
         with:

.gitignore

@@ -26,4 +26,7 @@ yarn-error.log*
 test-ledger/
 
 # GitHub Pages deploy directory
-.ghpages-deploy
+.ghpages-deploy
+
+# Codegenerated TypeDoc API
+docs/

README.md

@@ -7,6 +7,7 @@
     "scripts": {
         "build": "turbo run --concurrency=${TURBO_CONCURRENCY:-95.84%} build",
         "compile": "turbo run --concurrency=${TURBO_CONCURRENCY:-95.84%} compile:js compile:typedefs",
+        "compile:ghpages": "typedoc",
         "lint": "turbo run --concurrency=${TURBO_CONCURRENCY:-95.84%} test:lint",
         "style:fix": "turbo  run --concurrency=${TURBO_CONCURRENCY:-95.84%} style:fix && pnpm prettier --log-level warn --ignore-unknown --write '{.,!packages}/*'",
         "test": "turbo run --concurrency=${TURBO_CONCURRENCY:-95.84%} test:unit:browser test:unit:node",
@@ -47,6 +48,8 @@
         "ts-node": "^10.9.2",
         "tsup": "^8.3.5",
         "turbo": "^2.2.3",
+        "typedoc": "^0.26.10",
+        "typedoc-plugin-missing-exports": "^3.0.0",
         "typescript": "^5.6.3"
     },
     "engineStrict": true,

package.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/accounts/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/addresses/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/assertions/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/build-scripts/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/codecs-core/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/codecs-data-structures/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/codecs-numbers/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/codecs-strings/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/codecs/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/compat/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/crypto-impl/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/errors/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/fast-stable-stringify/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/fetch-impl/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/functional/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/instructions/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/keys/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/library/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/options/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/programs/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/promises/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/react/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/rpc-api/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/rpc-graphql/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/rpc-parsed-types/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/rpc-spec-types/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/rpc-spec/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/rpc-subscriptions-api/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/rpc-subscriptions-channel-websocket/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/rpc-subscriptions-spec/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/rpc-subscriptions/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/rpc-transformers/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/rpc-transport-http/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/rpc-types/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/rpc/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/signers/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/subscribable/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/sysvars/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/test-config/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/test-matchers/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/text-encoding-impl/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/transaction-confirmation/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/transaction-messages/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/transactions/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/tsconfig/typedoc.json

@@ -0,0 +1,3 @@
+{
+    "$schema": "https://typedoc.org/schema.json"
+}

packages/typedoc.base.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}

packages/webcrypto-ed25519-polyfill/typedoc.json

@@ -0,0 +1,5 @@
+{
+    "$schema": "https://typedoc.org/schema.json",
+    "extends": ["../typedoc.base.json"],
+    "entryPoints": ["src/index.ts"]
+}