diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 8e774f0a..fb592714 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -40,7 +40,5 @@ jobs: uses: crazy-max/ghaction-github-pages@v2.5.0 with: build_dir: docs - jekyll: false - fqdn: js.semaphore.pse.dev env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.gitignore b/.gitignore index a14a7e59..e50cafc3 100644 --- a/.gitignore +++ b/.gitignore @@ -63,9 +63,7 @@ node_modules/ # Production build dist -docs/* -!docs/CNAME -!docs/index.html +docs # Hardhat artifacts diff --git a/README.md b/README.md index 932e8a8a..5941de6c 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ - Semaphore icon. + Semaphore icon Semaphore @@ -94,7 +94,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/ @semaphore-protocol/identity - + (docs) @@ -116,7 +116,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/ @semaphore-protocol/group - + (docs) @@ -138,7 +138,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/ @semaphore-protocol/proof - + (docs) @@ -160,7 +160,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/ @semaphore-protocol/data - + (docs) @@ -220,7 +220,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/ @semaphore-protocol/heyauthn - + (docs) diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index c2543f7c..00000000 --- a/docs/index.html +++ /dev/null @@ -1,123 +0,0 @@ - - - - - - - Semaphore packages - - - - - -
-
- - - -

Semaphore packages

-
-

- A monorepo of Semaphore packages. -

- -
- - - - diff --git a/package.json b/package.json index 39785687..6d68a7bc 100644 --- a/package.json +++ b/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": { diff --git a/packages/cli/package.json b/packages/cli/package.json index 18c62d95..b8c6c260 100644 --- a/packages/cli/package.json +++ b/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", diff --git a/packages/data/package.json b/packages/data/package.json index eb012f13..d2ab56cf 100644 --- a/packages/data/package.json +++ b/packages/data/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/data" + "prepublishOnly": "yarn build" }, "publishConfig": { "access": "public" @@ -32,8 +31,7 @@ "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", diff --git a/packages/data/typedoc.json b/packages/data/typedoc.json new file mode 100644 index 00000000..77a471c9 --- /dev/null +++ b/packages/data/typedoc.json @@ -0,0 +1,3 @@ +{ + "entryPoints": ["src/index.ts"] +} diff --git a/packages/group/package.json b/packages/group/package.json index 2302f010..c9a6b0c7 100644 --- a/packages/group/package.json +++ b/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", diff --git a/packages/group/typedoc.json b/packages/group/typedoc.json new file mode 100644 index 00000000..77a471c9 --- /dev/null +++ b/packages/group/typedoc.json @@ -0,0 +1,3 @@ +{ + "entryPoints": ["src/index.ts"] +} diff --git a/packages/heyauthn/package.json b/packages/heyauthn/package.json index 9c19e8b8..46ae60dd 100644 --- a/packages/heyauthn/package.json +++ b/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", diff --git a/packages/heyauthn/typedoc.json b/packages/heyauthn/typedoc.json new file mode 100644 index 00000000..77a471c9 --- /dev/null +++ b/packages/heyauthn/typedoc.json @@ -0,0 +1,3 @@ +{ + "entryPoints": ["src/index.ts"] +} diff --git a/packages/identity/package.json b/packages/identity/package.json index 5b7d1ac0..34dcb371 100644 --- a/packages/identity/package.json +++ b/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", diff --git a/packages/identity/typedoc.json b/packages/identity/typedoc.json new file mode 100644 index 00000000..77a471c9 --- /dev/null +++ b/packages/identity/typedoc.json @@ -0,0 +1,3 @@ +{ + "entryPoints": ["src/index.ts"] +} diff --git a/packages/proof/package.json b/packages/proof/package.json index d5f4234b..1d452cf5 100644 --- a/packages/proof/package.json +++ b/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", diff --git a/packages/proof/typedoc.json b/packages/proof/typedoc.json new file mode 100644 index 00000000..77a471c9 --- /dev/null +++ b/packages/proof/typedoc.json @@ -0,0 +1,3 @@ +{ + "entryPoints": ["src/index.ts"] +} diff --git a/typedoc.json b/typedoc.json new file mode 100644 index 00000000..390a46a1 --- /dev/null +++ b/typedoc.json @@ -0,0 +1,6 @@ +{ + "entryPoints": ["packages/*"], + "name": "Semaphore SDK", + "entryPointStrategy": "packages", + "exclude": ["**/cli-template*", "**/circuits", "**/contracts", "**/hardhat", "**/cli"] +} diff --git a/yarn.lock.REMOVED.git-id b/yarn.lock.REMOVED.git-id index 4bd6a8f3..0f678892 100644 --- a/yarn.lock.REMOVED.git-id +++ b/yarn.lock.REMOVED.git-id @@ -1 +1 @@ -14647f7bb1147ded614a3201a53e50dbecc65188 \ No newline at end of file +295230ab1cdf7716e4ed2a3e0153f3e5ae3cc6bc \ No newline at end of file