Merge pull request #424 from oasisprotocol/matevz/docs/typedoc

Use typedoc for integrations/* packages too
oasisprotocol · Oct 3, 2024 · f708f39 · f708f39
2 parents 7e252fb + 4298613
commit f708f39
Show file tree

Hide file tree

Showing 16 changed files with 16,104 additions and 15,929 deletions.
diff --git a/.github/workflows/ci-docs.yaml b/.github/workflows/ci-docs.yaml
@@ -51,19 +51,38 @@ jobs:
             ${{ runner.os }}-pnpm-store-
 
       - name: Install dependencies
-        run: pnpm --filter @oasisprotocol/sapphire-paratime install
+        run: pnpm install
 
-      - name: Build docs
+      - name: Build client/js docs
         run: |
+          mkdir ../../docs-api
+          pnpm build # Required for integrations/
           pnpm typedoc
+          mv docs/api ../../docs-api/sapphire-paratime
+
+      - name: Build integrations docs
+        working-directory: ./integrations
+        run: |
+          for i in */ ; do
+            pushd $i
+            pnpm build # Required for typedoc
+            if [ "$i" == "hardhat/" ]; then
+              # XXX: ExampleModule.ts is not compilable but is there for linting and example.
+              pnpm typedoc --tsconfig tsconfig.build.json
+            else
+              pnpm typedoc
+            fi
+            mv docs/api ../../docs-api/sapphire-$i
+            popd
+          done
 
       - name: Deploy to api-reference branch
         uses: peaceiris/actions-gh-pages@v4
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: clients/js/docs/api
+          publish_dir: docs-api
           publish_branch: api-reference
-          destination_dir: js/sapphire-paratime
+          destination_dir: js
           commit_message: Deploy js API reference ${{ github.event.head_commit.message }}
           user_name: github-actions[bot]
           user_email: 41898282+github-actions[bot]@users.noreply.github.com

diff --git a/clients/js/package.json b/clients/js/package.json
@@ -60,7 +60,7 @@
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.2",
     "tweetnacl": "^1.0.3",
-    "typedoc": "^0.25.4",
+    "typedoc": "^0.25.13",
     "typescript": "^4.8.3"
   }
 }
diff --git a/examples/wagmi-v2/package.json b/examples/wagmi-v2/package.json
@@ -19,7 +19,7 @@
 		"abitype": "^1.0.2",
 		"react": "^18.2.0",
 		"react-dom": "^18.2.0",
-		"wagmi": "~2.5.20"
+		"wagmi": "2.x"
 	},
 	"devDependencies": {
 		"@biomejs/biome": "^1.7.0",

diff --git a/integrations/ethers-v6/.gitignore b/integrations/ethers-v6/.gitignore
@@ -1,2 +1,3 @@
-dist
-coverage
+dist/
+coverage/
+docs/
diff --git a/integrations/ethers-v6/package.json b/integrations/ethers-v6/package.json
@@ -59,6 +59,7 @@
 		"chai": "^5.1.0",
 		"mocha": "^10.4.0",
 		"ts-node": "^10.9.2",
+		"typedoc": "^0.25.13",
 		"typescript": "^5.3.3"
 	}
 }
diff --git a/integrations/ethers-v6/tsconfig.base.json b/integrations/ethers-v6/tsconfig.base.json
@@ -27,5 +27,11 @@
 		"lib": ["ES2022", "DOM"],
 
 		"skipLibCheck": true
+	},
+	"typedocOptions": {
+		"entryPoints": ["src/index.ts"],
+		"out": "docs/api",
+		"excludeInternal": true,
+		"excludePrivate": true
 	}
 }
diff --git a/integrations/hardhat/.gitignore b/integrations/hardhat/.gitignore
@@ -1,5 +1,6 @@
 dist/
+docs/
 cache/
 artifacts/
 typechain-types/
-ignition/deployments/
+ignition/deployments/
diff --git a/integrations/hardhat/package.json b/integrations/hardhat/package.json
@@ -47,6 +47,7 @@
     "prettier": "^2.8.8",
     "ts-node": "^8.10.2",
     "typechain": "^8.3.2",
+    "typedoc": "^0.25.13",
     "typescript": "5.x"
   },
   "peerDependencies": {

diff --git a/integrations/hardhat/tsconfig.base.json b/integrations/hardhat/tsconfig.base.json
@@ -14,5 +14,11 @@
     "@oasisprotocol/sapphire-hardhat": ["src/index"],
     "@oasisprotocol/sapphire-hardhat/*": ["src/*"]
   },
-  "exclude": ["dist", "node_modules"]
+  "exclude": ["dist", "node_modules"],
+  "typedocOptions": {
+    "entryPoints": ["src/index.ts"],
+    "out": "docs/api",
+    "excludeInternal": true,
+    "excludePrivate": true
+  }
 }
diff --git a/integrations/viem-v2/.gitignore b/integrations/viem-v2/.gitignore
@@ -1,4 +1,5 @@
 node_modules/
 dist/
+docs/
 *.tgz
 *.tsbuildinfo
diff --git a/integrations/viem-v2/package.json b/integrations/viem-v2/package.json
@@ -62,6 +62,7 @@
 		"@types/node": "^18.19.31",
 		"rimraf": "^6.0.1",
 		"ts-node": "^10.9.2",
+		"typedoc": "^0.25.13",
 		"typescript": "^5.4.5",
 		"vitest": "^1.6.0"
 	}

diff --git a/integrations/viem-v2/tsconfig.base.json b/integrations/viem-v2/tsconfig.base.json
@@ -27,5 +27,11 @@
 		"lib": ["ES2022", "DOM"],
 
 		"skipLibCheck": true
+	},
+	"typedocOptions": {
+		"entryPoints": ["src/index.ts"],
+		"out": "docs/api",
+		"excludeInternal": true,
+		"excludePrivate": true
 	}
 }
diff --git a/integrations/wagmi-v2/.gitignore b/integrations/wagmi-v2/.gitignore
@@ -1,4 +1,5 @@
 node_modules/
 dist/
+docs/
 *.tgz
 *.tsbuildinfo
diff --git a/integrations/wagmi-v2/package.json b/integrations/wagmi-v2/package.json
@@ -36,13 +36,13 @@
 	"dependencies": {
 		"@oasisprotocol/sapphire-paratime": "workspace:^",
 		"@oasisprotocol/sapphire-viem-v2": "workspace:^",
-		"viem": "2.x",
-		"@wagmi/core": "2.x"
+		"@wagmi/core": "2.x",
+		"viem": "2.x"
 	},
 	"peerDependencies": {
 		"@oasisprotocol/sapphire-paratime": "workspace:^",
 		"@oasisprotocol/sapphire-viem-v2": "workspace:^",
-		"@wagmi/core": "^2.6.9",
+		"@wagmi/core": "2.x",
 		"typescript": ">=5.0.4",
 		"viem": "2.x",
 		"wagmi": "2.x"
@@ -65,6 +65,7 @@
 		"@biomejs/biome": "^1.7.0",
 		"@types/node": "^18.19.31",
 		"ts-node": "^10.9.2",
+		"typedoc": "^0.25.13",
 		"typescript": "^5.4.5"
 	}
 }
diff --git a/integrations/wagmi-v2/tsconfig.base.json b/integrations/wagmi-v2/tsconfig.base.json
@@ -27,5 +27,11 @@
 		"lib": ["ES2022", "DOM"],
 
 		"skipLibCheck": true
+	},
+	"typedocOptions": {
+		"entryPoints": ["src/index.ts"],
+		"out": "docs/api",
+		"excludeInternal": true,
+		"excludePrivate": true
 	}
 }