New typedoc configuration

.github/workflows/docs.yml

@@ -40,7 +40,5 @@ jobs:
               uses: crazy-max/[email protected]
               with:
                   build_dir: docs
-                  jekyll: false
-                  fqdn: js.semaphore.pse.dev
               env:
                   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -63,9 +63,7 @@ node_modules/
 # Production
 build
 dist
-docs/*
-!docs/CNAME
-!docs/index.html
+docs
 
 # Hardhat
 artifacts

README.md

@@ -3,7 +3,7 @@
       <picture>
         <source media="(prefers-color-scheme: dark)" srcset="https://github.com/semaphore-protocol/website/blob/main/static/img/semaphore-icon-dark.svg">
         <source media="(prefers-color-scheme: light)" srcset="https://github.com/semaphore-protocol/website/blob/main/static/img/semaphore-icon.svg">
-        <img width="40" alt="Semaphore icon." src="https://github.com/semaphore-protocol/website/blob/main/static/img/semaphore-icon.svg">
+        <img width="40" alt="Semaphore icon" src="https://github.com/semaphore-protocol/website/blob/main/static/img/semaphore-icon.svg">
       </picture>
       Semaphore
     </h1>
@@ -94,7 +94,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/
                 <a href="/packages/identity">
                     @semaphore-protocol/identity
                 </a>
-                <a href="https://js.semaphore.pse.dev/identity">
+                <a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_identity">
                     (docs)
                 </a>
             </td>
@@ -116,7 +116,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/
                 <a href="/packages/group">
                     @semaphore-protocol/group
                 </a>
-                <a href="https://js.semaphore.pse.dev/group">
+                <a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_group">
                     (docs)
                 </a>
             </td>
@@ -138,7 +138,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/
                 <a href="/packages/proof">
                     @semaphore-protocol/proof
                 </a>
-                <a href="https://js.semaphore.pse.dev/proof">
+                <a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_proof">
                     (docs)
                 </a>
             </td>
@@ -160,7 +160,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/
                 <a href="/packages/data">
                     @semaphore-protocol/data
                 </a>
-                <a href="https://js.semaphore.pse.dev/data">
+                <a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_data">
                     (docs)
                 </a>
             </td>
@@ -220,7 +220,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/
                 <a href="/packages/heyauthn">
                     @semaphore-protocol/heyauthn
                 </a>
-                <a href="https://js.semaphore.pse.dev/heyauthn">
+                <a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_heyauthn">
                     (docs)
                 </a>
             </td>

package.json

@@ -17,7 +17,7 @@
         "lint": "eslint . --ext .js,.ts && yarn workspace contracts lint",
         "prettier": "prettier -c .",
         "prettier:write": "prettier -w .",
-        "docs": "yarn workspaces foreach --no-private run docs",
+        "docs": "typedoc --cname js.semaphore.pse.dev --githubPages true",
         "version:bump": "yarn workspaces foreach --no-private version -d ${0} && yarn version apply --all && git commit -am \"chore: v${0}\" && git tag v${0}",
         "version:publish": "yarn build:libraries && yarn remove:template-files && yarn workspaces foreach --no-private npm publish --tolerate-republish --access public",
         "version:release": "changelogithub",
@@ -77,6 +77,7 @@
         "rollup": "^2.64.0",
         "ts-node": "^10.4.0",
         "tslib": "^2.3.1",
+        "typedoc": "^0.25.1",
         "typescript": "^4.7.0"
     },
     "config": {

packages/cli/package.json

@@ -39,8 +39,7 @@
         "@types/semver": "^7.3.13",
         "rollup-plugin-cleanup": "^3.2.1",
         "rollup-plugin-typescript2": "^0.31.2",
-        "ts-node": "^10.9.1",
-        "typedoc": "^0.22.11"
+        "ts-node": "^10.9.1"
     },
     "dependencies": {
         "@semaphore-protocol/data": "3.11.0",

packages/data/package.json

@@ -23,17 +23,15 @@
     "scripts": {
         "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
         "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
-        "prepublishOnly": "yarn build",
-        "docs": "typedoc src/index.ts --out ../../docs/data"
+        "prepublishOnly": "yarn build"
     },
     "publishConfig": {
         "access": "public"
     },
     "devDependencies": {
         "@rollup/plugin-json": "^6.0.0",
         "rollup-plugin-cleanup": "^3.2.1",
-        "rollup-plugin-typescript2": "^0.31.2",
-        "typedoc": "^0.22.11"
+        "rollup-plugin-typescript2": "^0.31.2"
     },
     "dependencies": {
         "@ethersproject/contracts": "^5.7.0",

packages/data/typedoc.json

@@ -0,0 +1,3 @@
+{
+    "entryPoints": ["src/index.ts"]
+}

packages/group/package.json

@@ -23,8 +23,7 @@
     "scripts": {
         "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
         "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
-        "prepublishOnly": "yarn build",
-        "docs": "typedoc src/index.ts --out ../../docs/group"
+        "prepublishOnly": "yarn build"
     },
     "publishConfig": {
         "access": "public"
@@ -34,8 +33,7 @@
         "@rollup/plugin-node-resolve": "^15.0.1",
         "poseidon-lite": "^0.2.0",
         "rollup-plugin-cleanup": "^3.2.1",
-        "rollup-plugin-typescript2": "^0.31.2",
-        "typedoc": "^0.22.11"
+        "rollup-plugin-typescript2": "^0.31.2"
     },
     "dependencies": {
         "@ethersproject/bignumber": "^5.7.0",

packages/group/typedoc.json

@@ -0,0 +1,3 @@
+{
+    "entryPoints": ["src/index.ts"]
+}

packages/heyauthn/package.json

@@ -23,16 +23,14 @@
     "scripts": {
         "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
         "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
-        "prepublishOnly": "yarn build",
-        "docs": "typedoc src/index.ts --out ../../docs/heyauthn"
+        "prepublishOnly": "yarn build"
     },
     "publishConfig": {
         "access": "public"
     },
     "devDependencies": {
         "rollup-plugin-cleanup": "^3.2.1",
-        "rollup-plugin-typescript2": "^0.31.2",
-        "typedoc": "^0.22.11"
+        "rollup-plugin-typescript2": "^0.31.2"
     },
     "dependencies": {
         "@semaphore-protocol/identity": "3.11.0",

packages/heyauthn/typedoc.json

@@ -0,0 +1,3 @@
+{
+    "entryPoints": ["src/index.ts"]
+}

packages/identity/package.json

@@ -23,8 +23,7 @@
     "scripts": {
         "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
         "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
-        "prepublishOnly": "yarn build",
-        "docs": "typedoc src/index.ts --out ../../docs/identity"
+        "prepublishOnly": "yarn build"
     },
     "publishConfig": {
         "access": "public"
@@ -34,8 +33,7 @@
         "@rollup/plugin-node-resolve": "^15.0.1",
         "poseidon-lite": "^0.2.0",
         "rollup-plugin-cleanup": "^3.2.1",
-        "rollup-plugin-typescript2": "^0.31.2",
-        "typedoc": "^0.22.11"
+        "rollup-plugin-typescript2": "^0.31.2"
     },
     "dependencies": {
         "@ethersproject/bignumber": "^5.5.0",

packages/identity/typedoc.json

@@ -0,0 +1,3 @@
+{
+    "entryPoints": ["src/index.ts"]
+}

packages/proof/package.json

@@ -23,8 +23,7 @@
     "scripts": {
         "build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
         "build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
-        "prepublishOnly": "yarn build",
-        "docs": "typedoc src/index.ts --out ../../docs/proof"
+        "prepublishOnly": "yarn build"
     },
     "publishConfig": {
         "access": "public"
@@ -36,8 +35,7 @@
         "ffjavascript": "^0.2.54",
         "poseidon-lite": "^0.2.0",
         "rollup-plugin-cleanup": "^3.2.1",
-        "rollup-plugin-typescript2": "^0.31.2",
-        "typedoc": "^0.22.11"
+        "rollup-plugin-typescript2": "^0.31.2"
     },
     "peerDependencies": {
         "@semaphore-protocol/group": "3.11.0",

packages/proof/typedoc.json

@@ -0,0 +1,3 @@
+{
+    "entryPoints": ["src/index.ts"]
+}

typedoc.json

@@ -0,0 +1,6 @@
+{
+    "entryPoints": ["packages/*"],
+    "name": "Semaphore SDK",
+    "entryPointStrategy": "packages",
+    "exclude": ["**/cli-template*", "**/circuits", "**/contracts", "**/hardhat", "**/cli"]
+}