Start automated aggregation and surfacing of internal documentation w…

…ith rustdoc
TraceMachina · Mar 2, 2024 · 1bc38d3 · 1bc38d3
1 parent 5df8a78
commit 1bc38d3
Show file tree

Hide file tree

Showing 4 changed files with 404 additions and 0 deletions.
diff --git a/nativelink-config/Cargo.toml b/nativelink-config/Cargo.toml
@@ -6,3 +6,6 @@ edition = "2021"
 [dependencies]
 serde = { version = "1.0.193", features = ["derive"] }
 shellexpand = "3.1.0"
+
+[package.metadata.docs.rs]
+readme = "./README.md"
diff --git a/nativelink-config/examples/README.md b/nativelink-config/examples/README.md
diff --git a/nativelink-config/src/lib.rs b/nativelink-config/src/lib.rs
@@ -12,6 +12,64 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/README.md"))]
+#![doc = "\n\n"] // Add some spacing between the two README files
+#![doc = "
+<details>
+  <summary>Example Configuration Breakdown</summary>
+"]
+#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/examples/README.md"))]
+#![doc = "</details>"]
+#![doc = "
+<details>
+  <summary>Example Kubernetes Configuraton Breakdown</summary>
+"]
+#![doc = "
+<details>
+  <summary>CAS JSON Config</summary>
+"]
+#![doc = "\n"]
+#![doc = "```json"]
+#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/../deployment-examples/kubernetes/cas.json"))]
+#![doc = "```"]
+#![doc = "\n"]
+#![doc = "</details>"]
+#![doc = "
+<details>
+  <summary>Scheduler JSON Config</summary>
+"]
+#![doc = "\n"]
+#![doc = "```json"]
+#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/../deployment-examples/kubernetes/scheduler.json"))]
+#![doc = "```"]
+#![doc = "\n"]
+#![doc = "</details>"]
+#![doc = "
+<details>
+  <summary>Scheduler YAML</summary>
+"]
+#![doc = "\n"]
+#![doc = "```yaml"]
+#![doc = "# Test"]
+#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/../deployment-examples/kubernetes/scheduler.yaml"))]
+#![doc = "```"]
+#![doc = "\n"]
+#![doc = "</details>"]
+#![doc = "
+<details>
+  <summary>CAS YAML</summary>
+"]
+#![doc = "\n"]
+#![doc = "```yaml"]
+#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/../deployment-examples/kubernetes/cas.yaml"))]
+#![doc = "```"]
+#![doc = "\n"]
+#![doc = "</details>"]
+#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/../deployment-examples/kubernetes/README.md"))]
+#![doc = "</details>"]
+#![doc = "\n\n"] // Add some spacing between the two README files
+#![doc = "</details>"]
+
 pub mod cas_server;
 pub mod schedulers;
 mod serde_utils;