Skip to content

Add warning to rustdocs when building from main branch #493

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

Merged
dyc3 merged 1 commit into from
Aug 24, 2023
Merged

Add warning to rustdocs when building from main branch #493

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
6 changes: 5 additions & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
#![doc = include_str!("../README.md")] // Points to the main project README.
#![cfg_attr(
unstable_doc,
doc = "**❗ NOTE:** This documentation is sourced from the `main` branch. If you're looking for the most recent stable release, go [here](https://docs.rs/valence/latest/valence/).\n\n---\n"
)]
#![doc = include_str!("../README.md")]
#![doc(
html_logo_url = "https://raw.githubusercontent.com/valence-rs/valence/main/assets/logo.svg",
html_favicon_url = "https://raw.githubusercontent.com/valence-rs/valence/main/assets/logo.svg"
Expand Down
2 changes: 1 addition & 1 deletion website/build.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ zola build
mdbook build

# build rustdoc
cargo doc --no-deps --workspace --all-features
RUSTDOCFLAGS='--cfg unstable_doc' cargo doc --no-deps --workspace --all-features
cp -r ../target/doc/* public/rustdoc

# copy logo assets
Expand Down