bevyengine / bevyengine/bevy

Consider validating that docs can build as on docs.rs in CI

Open
#12,379 0 comments 0 reactions 0 assignees View on GitHub
A-Build-System C-Docs C-Feature
Dominant language
Rust
Stars
48.2k
Forks
4.8k
Avg merge
3d 22h
Merged PRs (30d)
161

Description

> I added the `doc_auto_cfg` feature to the same set of crates. It highlights which items are specific to feature or target. It is [documented here](https://github.com/rust-lang/rust/blob/master/src/doc/rustdoc/src/unstable-features.md#doc_auto_cfg-automatically-generate-doccfg), and only runs on docs.rs. Might be worth considering using https://github.com/dtolnay/cargo-docs-rs on CI.

_Originally posted by @yrns in https://github.com/bevyengine/bevy/issues/12366#issuecomment-1986125500_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.