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

Documentation upgrades #66

Merged
merged 4 commits into from
Apr 5, 2024
Merged

Documentation upgrades #66

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b11d28b
documentation upgrades for scraping examples
nkzou Apr 2, 2024
64849e3
update openapi to latest
nkzou Apr 2, 2024
a114438
regenerate
nkzou Apr 2, 2024
51c11d3
Merge branch 'master' into kevinzou/docs_upgrades
nkzou Apr 5, 2024
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
8 changes: 4 additions & 4 deletions .apigentools-info
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2024-04-02 13:17:34.863132",
"spec_repo_commit": "de9967cc"
"regenerated": "2024-03-29 13:20:47.377297",
"spec_repo_commit": "3e55ad68"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-04-02 13:17:34.881540",
"spec_repo_commit": "de9967cc"
"regenerated": "2024-03-29 13:20:47.394748",
"spec_repo_commit": "3e55ad68"
}
}
}
1 change: 1 addition & 0 deletions .generator/src/generator/templates/lib.j2
View file
Open in desktop
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
View file
Open in desktop
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 @@ -65,3 +66,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
View file
Open in desktop
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
View file
Open in desktop
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
Loading