Skip to content

Commit

Permalink
Documentation upgrades (#66)
Browse files Browse the repository at this point in the history
  • Loading branch information
nkzou authored Apr 5, 2024
1 parent b63e9b5 commit 4abdb8d
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 1 deletion.
1 change: 1 addition & 0 deletions .generator/src/generator/templates/lib.j2
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{% include "partial_header.j2" %}
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
#![doc = include_str!("../README.md")]

pub mod datadog;
pub mod datadogV1;
Expand Down
8 changes: 8 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ include = [
"/README.md",
"/src/**/*",
"/tests/**/*",
"/examples/*",
]
keywords = [
"datadog",
Expand Down Expand Up @@ -66,3 +67,10 @@ vcr-cassette = "2.0.1"
[[test]]
harness = false # allows Cucumber to print output instead of libtest
name = "main"

[[example]] # signal to Cargo that dev-dependencies are allowed for examples
doc-scrape-examples = true
name="v1_authentication_validate"

[package.metadata.docs.rs]
cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"]
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ datadog-api-client = "0"

Please follow the [installation](#installation) instructions and try the following snippet to validate your Datadog API key:

```Rust
```rust
use datadog_api_client::datadog::configuration::Configuration;
use datadog_api_client::datadogV1::api::api_authentication::AuthenticationAPI;

Expand Down
1 change: 1 addition & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
// Copyright 2019-Present Datadog, Inc.
#![allow(non_camel_case_types)]
#![allow(non_snake_case)]
#![doc = include_str!("../README.md")]

pub mod datadog;
pub mod datadogV1;
Expand Down

0 comments on commit 4abdb8d

Please sign in to comment.