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.

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

Fix broken links in readme, docs and missing features #19

Merged
merged 2 commits into from
Mar 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -131,3 +131,7 @@ required-features = ["std"]
name = "benchmarks"
harness = false
required-features = ["std"]

[package.metadata.docs.rs]
all-features = true
rustdoc-args = ["--cfg", "docsrs"]
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ Consider reading the [User Guide](https://ten3roberts.github.io/flax/guide)
## Features

- [Declarative component macro](https://docs.rs/flax/latest/flax/macro.component.html)
- [Expressive query system](https://docs.rs/flax/latest/flax/struct.Query.html)
- [Change detection](https://docs.rs/flax/latest/flax/struct.Component.html#method.modified)
- [Expressive query system](https://docs.rs/flax/latest/flax/query/struct.Query.html)
- [Change detection](https://docs.rs/flax/latest/flax/component/struct.Component.html#method.modified)
- [Query filtering](https://docs.rs/flax/latest/flax/filter/index.html)
- [System execution](https://docs.rs/flax/latest/flax/system/struct.System.html)
- [Multithreaded system execution](https://docs.rs/flax/latest/flax/schedule/struct.Schedule.html)
- [Many to many entity relation and graphs](https://docs.rs/flax/latest/flax/macro.component.html#relations)
- [Reflection through component metadata](https://docs.rs/flax/latest/flax/macro.component.html)
- [Ergonomic entity builder](https://docs.rs/flax/latest/flax/struct.EntityBuilder.html)
- [Ergonomic entity builder](https://docs.rs/flax/latest/flax/entity/struct.EntityBuilder.html)
- [Serialization and deserialization](https://docs.rs/flax/latest/flax/serialize/)
- [(async) event subscription](https://docs.rs/flax/latest/flax/struct.World.html#method.subscribe)
- [Runtime components](https://docs.rs/flax/latest/flax/struct.World.html#method.spawn_component)
- [(async) event subscription](https://docs.rs/flax/latest/flax/world/struct.World.html#method.subscribe)
- [Runtime components](https://docs.rs/flax/latest/flax/world/struct.World.html#method.spawn_component)
- ...and more

## [Live Demo](https://ten3roberts.github.io/flax/asteroids)
Expand Down
12 changes: 7 additions & 5 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,17 @@
//! ## Features
//!
//! - [Declarative component macro](https://docs.rs/flax/latest/flax/macro.component.html)
//! - [Queries](https://docs.rs/flax/latest/flax/struct.Query.html)
//! - [Change detection](https://docs.rs/flax/latest/flax/struct.Component.html#method.modified)
//! - [Expressive query system](https://docs.rs/flax/latest/flax/query/struct.Query.html)
//! - [Change detection](https://docs.rs/flax/latest/flax/component/struct.Component.html#method.modified)
//! - [Query filtering](https://docs.rs/flax/latest/flax/filter/index.html)
//! - [System execution](https://docs.rs/flax/latest/flax/system/struct.System.html)
//! - [Multithreaded system execution](https://docs.rs/flax/latest/flax/schedule/struct.Schedule.html)
//! - [Many to many entity relation and graphs](https://docs.rs/flax/latest/flax/macro.component.html#relations)
//! - [Reflection through component metadata](https://docs.rs/flax/latest/flax/macro.component.html)
//! - [Ergonomic entity builder](https://docs.rs/flax/latest/flax/struct.EntityBuilder.html)
//! - [Ergonomic entity builder](https://docs.rs/flax/latest/flax/entity/struct.EntityBuilder.html)
//! - [Serialization and deserialization](https://docs.rs/flax/latest/flax/serialize/)
//! - [(async) event subscription](https://docs.rs/flax/latest/flax/struct.World.html#method.subscribe)
//! - [Runtime components](https://docs.rs/flax/latest/flax/struct.World.html#method.spawn_component)
//! - [(async) event subscription](https://docs.rs/flax/latest/flax/world/struct.World.html#method.subscribe)
//! - [Runtime components](https://docs.rs/flax/latest/flax/world/struct.World.html#method.spawn_component)
//! - ...and more
//!
//! ## [Live Demo](https://ten3roberts.github.io/flax/asteroids)
Expand Down Expand Up @@ -195,6 +195,7 @@
#![deny(rustdoc::broken_intra_doc_links)]
#![deny(rustdoc::redundant_explicit_links)]
#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

extern crate alloc;

Expand Down Expand Up @@ -280,5 +281,6 @@ pub use world::World;
pub(crate) use query::ArchetypeSearcher;
pub(crate) use vtable::ComponentVTable;

#[doc(inline)]
#[cfg(feature = "derive")]
pub use flax_derive::*;
Loading