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

Add dokka setup for Kotlin API docs #655

Merged
merged 1 commit into from
Jan 24, 2025

Conversation

thunderbiscuit
Copy link
Member

@thunderbiscuit thunderbiscuit commented Jan 23, 2025

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 at http://localhost:8000/:

cd lib/build/dokka/html/
python -m http.server 8000
  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

@thunderbiscuit thunderbiscuit changed the title docs: add dokka setup for Kotlin API docs Add dokka setup for Kotlin API docs Jan 23, 2025
@reez reez self-requested a review January 23, 2025 15:00
Copy link
Collaborator

@reez reez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 04279c0

Thanks again for making it easy as a reviewer to follow the steps to test! I always really appreciate that.

Screenshot 2025-01-23 at 9 02 40 AM

@reez reez force-pushed the feature/api-docs branch from 04279c0 to 17a15cb Compare January 24, 2025 15:23
@reez reez merged commit 17a15cb into bitcoindevkit:master Jan 24, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants