Skip to content

Commit

Permalink
chore: fix typedoc generation (#988)
Browse files Browse the repository at this point in the history
upgrade typedoc to be happy with the version of tsc we use, and to drop
the ref to the missing css.

You can now run typedoc in the root of project again (as happens in CI)

```sh
❯ ./node_modules/.bin/typedoc
[info] Converting project at ./packages/access-client
[warning] No entry points were provided, this is likely a misconfiguration.
[info] Converting project at ./packages/capabilities
[info] Converting project at ./packages/upload-client
[info] Converting project at ./packages/filecoin-client
[info] Converting project at ./packages/w3up-client
[info] Merging converted projects
[info] Documentation generated at ./docs
```

fixes: #987

License: MIT

Signed-off-by: Oli Evans <oli@protocol.ai>
  • Loading branch information
olizilla authored Oct 19, 2023
1 parent a906488 commit bfbfc92
Show file tree
Hide file tree
Showing 3 changed files with 58 additions and 10 deletions.
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@
},
"dependencies": {
"depcheck": "^1.4.3",
"typedoc": "^0.23.28",
"typedoc-plugin-missing-exports": "^1.0.0"
"typedoc": "^0.25.2",
"typedoc-plugin-missing-exports": "^2.1.0"
},
"packageManager": "pnpm@7.24.3",
"pnpm": {
Expand Down
61 changes: 55 additions & 6 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@
"darkHighlightTheme": "github-dark",
"navigationLinks": {
"Github": "https://github.com/web3-storage/w3protocol"
},
"customCss": "./spec/docs.css"
}
}
}

0 comments on commit bfbfc92

Please sign in to comment.