Skip to content

improve docs for docs.rs #528

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

Closed
joseluis wants to merge 1 commit into from
Closed

improve docs for docs.rs #528

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
9 changes: 7 additions & 2 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@ categories = ["rendering::graphics-api"]

[features]

# Optional log-rs like macros implementation
# disabled by default
# Optional log-rs like macros implementation. Disabled by default
log-impl = []

# Documentation for docs.rs. Enables `doc_cfg` nightly feature
_docsrs = ["log-impl"]

[target.'cfg(target_os = "linux")'.dependencies]
libc = "0.2"

Expand Down Expand Up @@ -59,3 +61,6 @@ incremental = false
rpath = false
codegen-units = 1
strip = true

[package.metadata.docs.rs]
features = ["_docsrs"]
3 changes: 3 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
#![doc = include_str!("../README.md")]
#![cfg_attr(feature = "_docsrs", feature(doc_cfg))]

pub mod conf;
mod event;
pub mod fs;
Expand All @@ -8,6 +10,7 @@ use std::collections::HashMap;
use std::ops::{Index, IndexMut};

#[cfg(feature = "log-impl")]
#[cfg_attr(feature = "_docsrs", doc(cfg(feature = "log-impl")))]
pub mod log;

pub use event::*;
Expand Down
Loading