Add TypeDoc docs #207
Merged
Add TypeDoc docs #207
Conversation
This file contains 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
A `docs` script has been added for generating documentation with TypeDoc. Only public methods are documented, as this is mainly intended to help users of this library understand how to use it. A few additional types have been exported because they were referenced in public methods.
Gudahtt
force-pushed
the
add-typedoc
branch
from
cd9b0e1
to
8b06e5f
Compare
shanejonas
approved these changes
Sep 17, 2021
rekmarks
added a commit
to MetaMask/utils
that referenced
this pull request
May 15, 2022
Adds automated API docs generation via `typedoc` and automated publishing to GitHub pages. Closely follows the implementation in MetaMask/eth-sig-util#207 and MetaMask/eth-sig-util#213, but uses https://github.com/peaceiris/actions-gh-pages instead of our own GitHub Pages action, which we plan to sunset.
mcmire
pushed a commit
to mcmire/core
that referenced
this pull request
Jul 17, 2023
Adds automated API docs generation via `typedoc` and automated publishing to GitHub pages. Closely follows the implementation in MetaMask/eth-sig-util#207 and MetaMask/eth-sig-util#213, but uses https://github.com/peaceiris/actions-gh-pages instead of our own GitHub Pages action, which we plan to sunset.
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.
A
docsscript has been added for generating documentation with TypeDoc. Only public methods are documented, as this is mainly intended to help users of this library understand how to use it.A few additional types have been exported because they were referenced in public methods.