Merge pull request tree-sitter#2585 from mgunyho/include-readme-in-lib-docs

doc: Include README in top-level Rust module documentation

Author: ahlinc

cli/Cargo.toml

@@ -14,6 +14,7 @@ rust-version.workspace = true
 [[bin]]
 name = "tree-sitter"
 path = "src/main.rs"
+doc = false
 
 [[bench]]
 name = "benchmark"

cli/config/README.md

@@ -1,5 +1,7 @@
-# `tree-sitter-config`
+# Tree-sitter Config
+
+Manages Tree-sitter's configuration file.
 
 You can use a configuration file to control the behavior of the `tree-sitter`
-command-line program.  This crate implements the logic for finding and the
+command-line program. This crate implements the logic for finding and the
 parsing the contents of the configuration file.

cli/config/src/lib.rs

@@ -1,4 +1,4 @@
-//! Manages tree-sitter's configuration file.
+#![doc = include_str!("../README.md")]
 
 use anyhow::{anyhow, Context, Result};
 use serde::{Deserialize, Serialize};

cli/loader/README.md

@@ -1,6 +1,6 @@
-# `tree-sitter-loader`
+# Tree-sitter Loader
 
 The `tree-sitter` command-line program will dynamically find and build grammars
 at runtime, if you have cloned the grammars' repositories to your local
-filesystem.  This helper crate implements that logic, so that you can use it in
+filesystem. This helper crate implements that logic, so that you can use it in
 your own program analysis tools, as well.

cli/loader/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 use anyhow::{anyhow, Context, Error, Result};
 use libloading::{Library, Symbol};
 use once_cell::unsync::OnceCell;

cli/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 pub mod generate;
 pub mod highlight;
 pub mod logger;

highlight/README.md

@@ -1,4 +1,4 @@
-# `tree-sitter-highlight`
+# Tree-sitter Highlight
 
 [![crates.io badge]][crates.io]
 

highlight/src/lib.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("../README.md")]
+
 pub mod c_lib;
 pub mod util;
 pub use c_lib as c;

lib/binding_rust/bindings.rs

@@ -1,3 +1,5 @@
+#![doc = include_str!("./README.md")]
+
 pub mod ffi;
 mod util;