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.

Sign up for GitHub

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

Include README in generated rustdoc files. #12

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Include README in generated rustdoc files. #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 5 additions & 0 deletions crates/twirp-build/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# twirp-build

The `twirp-build` package is responsible for generating Twirp RPC service definitions from `.proto` files.

For more information, consult the documentation for the main `twirp` package.
2 changes: 2 additions & 0 deletions crates/twirp-build/src/lib.rs
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#![doc = include_str!("../README.md")]

use std::fmt::Write;

/// Generates twirp services for protobuf rpc service definitions.
Expand Down
2 changes: 2 additions & 0 deletions crates/twirp/src/lib.rs
100644 → 100755
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
#![doc = include_str!("../../../README.md")]

#[cfg(feature = "client")]
pub mod client;

Expand Down
Loading