Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: issue where typedoc docs would only show full docs for w3up-client #1141

Merged
merged 4 commits into from
Nov 15, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ const config = {
tsconfig: './tsconfig.json',
out: 'markdown',
sidebar: {
categoryLabel: 'w3protocol',
categoryLabel: 'w3up',
},
},
],
Expand Down
12 changes: 7 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,19 @@
"test": "pnpm -r --if-present run test",
"check": "pnpm -r --if-present run check",
"build": "pnpm -r --if-present run build",
"docs": "pnpm run build && typedoc --out docs",
"docs": "pnpm run build && typedoc --plugin typedoc-plugin-missing-exports --out docs",
"docs:markdown": "pnpm run build && docusaurus generate-typedoc"
},
"devDependencies": {
"@arethetypeswrong/cli": "^0.12.2",
"@docusaurus/core": "^2.3.1",
"docusaurus-plugin-typedoc": "^0.18.0",
"@docusaurus/core": "^3.0.0",
"@docusaurus/preset-classic": "^3.0.0",
"docusaurus-plugin-typedoc": "^0.21.0",
"lint-staged": "^13.2.0",
"prettier": "2.8.3",
"typedoc-plugin-markdown": "^3.14.0",
"react": "^18.2.0",
"typedoc": "^0.25.3",
"typedoc-plugin-markdown": "^3.17.0",
"typescript": "5.2.2"
},
"prettier": {
Expand All @@ -36,7 +39,6 @@
},
"dependencies": {
"depcheck": "^1.4.3",
"typedoc": "^0.25.2",
"typedoc-plugin-missing-exports": "^2.1.0"
},
"packageManager": "[email protected]",
Expand Down
3 changes: 3 additions & 0 deletions packages/access-client/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,8 @@
},
"include": ["src", "scripts", "test", "package.json"],
"exclude": ["**/node_modules/**"],
"typedocOptions": {
"entryPoints": ["./src"]
},
"references": [{ "path": "../capabilities" }, { "path": "../did-mailto" }]
}
1 change: 1 addition & 0 deletions packages/capabilities/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@
},
"ignorePatterns": [
"dist",
"docs",
"coverage",
"src/types.js"
]
Expand Down
5 changes: 4 additions & 1 deletion packages/capabilities/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,8 @@
"emitDeclarationOnly": true
},
"include": ["src", "test", "package.json"],
"exclude": ["**/node_modules/**"]
"exclude": ["**/node_modules/**"],
"typedocOptions": {
"entryPoints": ["./src"]
}
}
5 changes: 4 additions & 1 deletion packages/did-mailto/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,8 @@
},
"include": ["src", "test"],
"exclude": ["**/node_modules/**", "dist"],
"references": []
"references": [],
"typedocOptions": {
"entryPoints": ["./src"]
}
}
5 changes: 4 additions & 1 deletion packages/filecoin-api/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,8 @@
"references": [
{ "path": "../capabilities" },
{ "path": "../filecoin-client" }
]
],
"typedocOptions": {
"entryPoints": ["./src"]
}
}
5 changes: 4 additions & 1 deletion packages/filecoin-client/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,8 @@
},
"include": ["src", "test", "package.json"],
"exclude": ["**/node_modules/**"],
"references": [{ "path": "../capabilities" }]
"references": [{ "path": "../capabilities" }],
"typedocOptions": {
"entryPoints": ["./src"]
}
}
5 changes: 4 additions & 1 deletion packages/upload-api/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,8 @@
{ "path": "../capabilities" },
{ "path": "../access-client" },
{ "path": "../filecoin-api" }
]
],
"typedocOptions": {
"entryPoints": ["./src"]
}
}
5 changes: 4 additions & 1 deletion packages/upload-client/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,8 @@
},
"include": ["src", "scripts", "test", "package.json"],
"exclude": ["**/node_modules/**"],
"references": [{ "path": "../access-client" }, { "path": "../capabilities" }]
"references": [{ "path": "../access-client" }, { "path": "../capabilities" }],
"typedocOptions": {
"entryPoints": ["./src"]
}
}
36 changes: 0 additions & 36 deletions packages/w3up-client/docusaurus.config.cjs

This file was deleted.

18 changes: 6 additions & 12 deletions packages/w3up-client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,7 @@
"mock:bucket-200": "PORT=9200 STATUS=200 node test/helpers/bucket-server.js",
"mock:receipts-server": "PORT=9201 node test/helpers/receipts-server.js",
"rc": "npm version prerelease --preid rc",
"docs": "npm run build && typedoc --out docs-generated",
"docs:markdown": "npm run build && docusaurus generate-typedoc"
"docs": "npm run build && typedoc --out docs-generated"
},
"dependencies": {
"@ipld/dag-ucan": "^3.4.0",
Expand All @@ -108,26 +107,22 @@
"@web3-storage/upload-client": "workspace:^"
},
"devDependencies": {
"@web3-storage/upload-api": "workspace:^",
"@docusaurus/core": "^2.2.0",
"@ipld/car": "^5.1.1",
"@types/assert": "^1.5.6",
"@types/mocha": "^10.0.1",
"@types/node": "^20.8.4",
"@ucanto/server": "^9.0.1",
"@web3-storage/data-segment": "^5.0.0",
"@web3-storage/eslint-config-w3up": "workspace:^",
"@web3-storage/upload-api": "workspace:^",
"assert": "^2.0.0",
"c8": "^7.13.0",
"docusaurus-plugin-typedoc": "^0.18.0",
"hundreds": "^0.0.9",
"mocha": "^10.1.0",
"multiformats": "^12.1.2",
"npm-run-all": "^4.1.5",
"playwright-test": "^12.3.4",
"typedoc": "^0.23.24",
"typedoc-plugin-markdown": "^3.14.0",
"typedoc-plugin-missing-exports": "^1.0.0",
"typedoc": "^0.25.3",
"typescript": "^5.2.2"
},
"eslintConfig": {
Expand All @@ -145,6 +140,8 @@
},
"ignorePatterns": [
"dist",
"docs",
"docs-generated",
"coverage",
"src/types.js"
]
Expand Down Expand Up @@ -179,10 +176,7 @@
"@typescript-eslint/eslint-plugin",
"@typescript-eslint/parser",
"assert",
"c8",
"docusaurus-plugin-typedoc",
"typedoc-plugin-markdown",
"typedoc-plugin-missing-exports"
"c8"
]
}
}
8 changes: 1 addition & 7 deletions packages/w3up-client/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,7 @@
},
"include": ["./src", "./test"],
"typedocOptions": {
"entryPoints": ["./src"],
"entryPointStrategy": "expand",
"darkHighlightTheme": "github-dark",
"navigationLinks": {
"Github": "https://github.com/web3-storage/w3up-client"
},
"customCss": "./static/docs.css"
"entryPoints": ["./src"]
},
"references": [
{ "path": "../access-client" },
Expand Down
Loading
Loading