Fix API docs generation #264
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The recent addition of `web3` as a development dependency broke `yarn build:docs`, which generates API docs via TypeDoc and is run when a new version of the package is published. Curiously, `yarn build` continues to work. It seems that TypeDoc is using the development variant of the TypeScript configuration file instead of the build variant, which `yarn build` uses internally. The build variant limits the scope of TypeScript to just files within `src`, hiding dependencies. Correcting the TypeDoc config to use this file fixes the issue.
bergarces
approved these changes
Aug 28, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The addition of
web3as a development dependency in 0a6e1bd brokeyarn build:docs, which generates API docs via TypeDoc and is run when a new version of the package is published. Curiously,yarn buildcontinues to work.It seems that TypeDoc is using the development variant of the TypeScript configuration file instead of the build variant, which
yarn builduses internally. The build variant limits the scope of TypeScript to just files withinsrc, hiding dependencies. Correcting the TypeDoc config to use this file fixes the issue.References
Fixes #263.
Manual testing steps
yarn build:docs. You should not see any type errors.