Add dokka setup for Kotlin API docs #655
Merged
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.
This PR adds the required setup for Dokka 2.0, allowing us to build the API documentation for bdk-jvm and bdk-android. Note that the README files are what ends up on the homepage/landing page of the API docs website. You can build and test for yourself by running
cd bdk-jvm/ just build-docs
And open the
lib/build/dokka/html/index.html
file using a small live server like the one provided in vscode, or the built-in python one which should serve the website athttp://localhost:8000/
:cd lib/build/dokka/html/ python -m http.server 8000
cargo fmt
andcargo clippy
before committing