Skip to content

Commit fb66869

Browse files
cedoorcedoor
committed
chore: update typedoc configuration
re #360 Former-commit-id: 7ac640c
1 parent 7af714b commit fb66869

18 files changed

+42
-158
lines changed

‎.github/workflows/docs.yml

-2
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,5 @@ jobs:
4040
uses: crazy-max/[email protected]
4141
with:
4242
build_dir: docs
43-
jekyll: false
44-
fqdn: js.semaphore.pse.dev
4543
env:
4644
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore

+1-3
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,7 @@ node_modules/
6363
# Production
6464
build
6565
dist
66-
docs/*
67-
!docs/CNAME
68-
!docs/index.html
66+
docs
6967

7068
# Hardhat
7169
artifacts

‎README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<picture>
44
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/semaphore-protocol/website/blob/main/static/img/semaphore-icon-dark.svg">
55
<source media="(prefers-color-scheme: light)" srcset="https://github.com/semaphore-protocol/website/blob/main/static/img/semaphore-icon.svg">
6-
<img width="40" alt="Semaphore icon." src="https://github.com/semaphore-protocol/website/blob/main/static/img/semaphore-icon.svg">
6+
<img width="40" alt="Semaphore icon" src="https://github.com/semaphore-protocol/website/blob/main/static/img/semaphore-icon.svg">
77
</picture>
88
Semaphore
99
</h1>
@@ -94,7 +94,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/
9494
<a href="/packages/identity">
9595
@semaphore-protocol/identity
9696
</a>
97-
<a href="https://js.semaphore.pse.dev/identity">
97+
<a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_identity">
9898
(docs)
9999
</a>
100100
</td>
@@ -116,7 +116,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/
116116
<a href="/packages/group">
117117
@semaphore-protocol/group
118118
</a>
119-
<a href="https://js.semaphore.pse.dev/group">
119+
<a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_group">
120120
(docs)
121121
</a>
122122
</td>
@@ -138,7 +138,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/
138138
<a href="/packages/proof">
139139
@semaphore-protocol/proof
140140
</a>
141-
<a href="https://js.semaphore.pse.dev/proof">
141+
<a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_proof">
142142
(docs)
143143
</a>
144144
</td>
@@ -160,7 +160,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/
160160
<a href="/packages/data">
161161
@semaphore-protocol/data
162162
</a>
163-
<a href="https://js.semaphore.pse.dev/data">
163+
<a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_data">
164164
(docs)
165165
</a>
166166
</td>
@@ -220,7 +220,7 @@ The core of the Semaphore protocol is in the [circuit logic](/packages/circuits/
220220
<a href="/packages/heyauthn">
221221
@semaphore-protocol/heyauthn
222222
</a>
223-
<a href="https://js.semaphore.pse.dev/heyauthn">
223+
<a href="https://js.semaphore.pse.dev/modules/_semaphore_protocol_heyauthn">
224224
(docs)
225225
</a>
226226
</td>

‎docs/index.html

-123
This file was deleted.

‎package.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
"lint": "eslint . --ext .js,.ts && yarn workspace contracts lint",
1818
"prettier": "prettier -c .",
1919
"prettier:write": "prettier -w .",
20-
"docs": "yarn workspaces foreach --no-private run docs",
20+
"docs": "typedoc --cname js.semaphore.pse.dev --githubPages true",
2121
"version:bump": "yarn workspaces foreach --no-private version -d ${0} && yarn version apply --all && git commit -am \"chore: v${0}\" && git tag v${0}",
2222
"version:publish": "yarn build:libraries && yarn remove:template-files && yarn workspaces foreach --no-private npm publish --tolerate-republish --access public",
2323
"version:release": "changelogithub",
@@ -77,6 +77,7 @@
7777
"rollup": "^2.64.0",
7878
"ts-node": "^10.4.0",
7979
"tslib": "^2.3.1",
80+
"typedoc": "^0.25.1",
8081
"typescript": "^4.7.0"
8182
},
8283
"config": {

‎packages/cli/package.json

+1-2
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@
3939
"@types/semver": "^7.3.13",
4040
"rollup-plugin-cleanup": "^3.2.1",
4141
"rollup-plugin-typescript2": "^0.31.2",
42-
"ts-node": "^10.9.1",
43-
"typedoc": "^0.22.11"
42+
"ts-node": "^10.9.1"
4443
},
4544
"dependencies": {
4645
"@semaphore-protocol/data": "3.11.0",

‎packages/data/package.json

+2-4
Original file line numberDiff line numberDiff line change
@@ -23,17 +23,15 @@
2323
"scripts": {
2424
"build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
2525
"build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
26-
"prepublishOnly": "yarn build",
27-
"docs": "typedoc src/index.ts --out ../../docs/data"
26+
"prepublishOnly": "yarn build"
2827
},
2928
"publishConfig": {
3029
"access": "public"
3130
},
3231
"devDependencies": {
3332
"@rollup/plugin-json": "^6.0.0",
3433
"rollup-plugin-cleanup": "^3.2.1",
35-
"rollup-plugin-typescript2": "^0.31.2",
36-
"typedoc": "^0.22.11"
34+
"rollup-plugin-typescript2": "^0.31.2"
3735
},
3836
"dependencies": {
3937
"@ethersproject/contracts": "^5.7.0",

‎packages/data/typedoc.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"entryPoints": ["src/index.ts"]
3+
}

‎packages/group/package.json

+2-4
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@
2323
"scripts": {
2424
"build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
2525
"build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
26-
"prepublishOnly": "yarn build",
27-
"docs": "typedoc src/index.ts --out ../../docs/group"
26+
"prepublishOnly": "yarn build"
2827
},
2928
"publishConfig": {
3029
"access": "public"
@@ -34,8 +33,7 @@
3433
"@rollup/plugin-node-resolve": "^15.0.1",
3534
"poseidon-lite": "^0.2.0",
3635
"rollup-plugin-cleanup": "^3.2.1",
37-
"rollup-plugin-typescript2": "^0.31.2",
38-
"typedoc": "^0.22.11"
36+
"rollup-plugin-typescript2": "^0.31.2"
3937
},
4038
"dependencies": {
4139
"@ethersproject/bignumber": "^5.7.0",

‎packages/group/typedoc.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"entryPoints": ["src/index.ts"]
3+
}

‎packages/heyauthn/package.json

+2-4
Original file line numberDiff line numberDiff line change
@@ -23,16 +23,14 @@
2323
"scripts": {
2424
"build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
2525
"build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
26-
"prepublishOnly": "yarn build",
27-
"docs": "typedoc src/index.ts --out ../../docs/heyauthn"
26+
"prepublishOnly": "yarn build"
2827
},
2928
"publishConfig": {
3029
"access": "public"
3130
},
3231
"devDependencies": {
3332
"rollup-plugin-cleanup": "^3.2.1",
34-
"rollup-plugin-typescript2": "^0.31.2",
35-
"typedoc": "^0.22.11"
33+
"rollup-plugin-typescript2": "^0.31.2"
3634
},
3735
"dependencies": {
3836
"@semaphore-protocol/identity": "3.11.0",

‎packages/heyauthn/typedoc.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"entryPoints": ["src/index.ts"]
3+
}

‎packages/identity/package.json

+2-4
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@
2323
"scripts": {
2424
"build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
2525
"build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
26-
"prepublishOnly": "yarn build",
27-
"docs": "typedoc src/index.ts --out ../../docs/identity"
26+
"prepublishOnly": "yarn build"
2827
},
2928
"publishConfig": {
3029
"access": "public"
@@ -34,8 +33,7 @@
3433
"@rollup/plugin-node-resolve": "^15.0.1",
3534
"poseidon-lite": "^0.2.0",
3635
"rollup-plugin-cleanup": "^3.2.1",
37-
"rollup-plugin-typescript2": "^0.31.2",
38-
"typedoc": "^0.22.11"
36+
"rollup-plugin-typescript2": "^0.31.2"
3937
},
4038
"dependencies": {
4139
"@ethersproject/bignumber": "^5.5.0",

‎packages/identity/typedoc.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"entryPoints": ["src/index.ts"]
3+
}

‎packages/proof/package.json

+2-4
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,7 @@
2323
"scripts": {
2424
"build:watch": "rollup -c rollup.config.ts -w --configPlugin typescript",
2525
"build": "rimraf dist && rollup -c rollup.config.ts --configPlugin typescript",
26-
"prepublishOnly": "yarn build",
27-
"docs": "typedoc src/index.ts --out ../../docs/proof"
26+
"prepublishOnly": "yarn build"
2827
},
2928
"publishConfig": {
3029
"access": "public"
@@ -36,8 +35,7 @@
3635
"ffjavascript": "^0.2.54",
3736
"poseidon-lite": "^0.2.0",
3837
"rollup-plugin-cleanup": "^3.2.1",
39-
"rollup-plugin-typescript2": "^0.31.2",
40-
"typedoc": "^0.22.11"
38+
"rollup-plugin-typescript2": "^0.31.2"
4139
},
4240
"peerDependencies": {
4341
"@semaphore-protocol/group": "3.11.0",

‎packages/proof/typedoc.json

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"entryPoints": ["src/index.ts"]
3+
}

‎typedoc.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"entryPoints": ["packages/*"],
3+
"name": "Semaphore SDK",
4+
"entryPointStrategy": "packages",
5+
"exclude": ["**/cli-template*", "**/circuits", "**/contracts", "**/hardhat", "**/cli"]
6+
}

‎yarn.lock.REMOVED.git-id

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
14647f7bb1147ded614a3201a53e50dbecc65188
1+
295230ab1cdf7716e4ed2a3e0153f3e5ae3cc6bc

0 commit comments

Comments
 (0)