Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions bdk-ffi/deploy-docs.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
set -euo pipefail

just docs
cd ./target/doc/
git init .
git switch --create gh-pages
git add .
git commit --message "Deploy $(date +"%Y-%m-%d")"
git remote add upstream git@github.com:bitcoindevkit/bdk-ffi.git
git push upstream gh-pages --force
7 changes: 7 additions & 0 deletions bdk-ffi/justfile
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,10 @@ check:

test:
cargo test

# Build API documentation for gh-pages
docs:
cargo doc --no-deps
echo '<meta http-equiv="refresh" content="0; url=bdkffi/index.html">' > target/doc/index.html
@echo "Documentation built at target/doc/"
@echo "Push the contents of target/doc/ to gh-pages"
24 changes: 12 additions & 12 deletions bdk-ffi/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
mod bitcoin;
mod descriptor;
mod electrum;
mod error;
mod esplora;
mod keys;
mod kyoto;
mod macros;
mod store;
mod tx_builder;
mod types;
mod wallet;
pub mod bitcoin;
pub mod descriptor;
pub mod electrum;
pub mod error;
pub mod esplora;
pub mod keys;
pub mod kyoto;
pub mod macros;
pub mod store;
pub mod tx_builder;
pub mod types;
pub mod wallet;

#[cfg(test)]
mod tests;
Expand Down
Loading