From aab9f56da20a36347fe31557377e07a47c114dc6 Mon Sep 17 00:00:00 2001 From: mat Date: Mon, 15 Dec 2025 13:53:46 +0930 Subject: improve docs by enabling scraped examples and bevy trait tags --- docs-rs/README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 docs-rs/README.md (limited to 'docs-rs/README.md') diff --git a/docs-rs/README.md b/docs-rs/README.md new file mode 100644 index 00000000..3be1087a --- /dev/null +++ b/docs-rs/README.md @@ -0,0 +1,17 @@ +## Docs.rs Extensions + +This directory includes some templates and styling to extend and modify [rustdoc]'s output +for Azalea's documentation on [docs.rs]. + +See [Bevy's documentation](https://github.com/bevyengine/bevy/tree/main/docs-rs) for more info. + +## Local Testing + +Build the documentation with the extension enabled like this: + +```bash +RUSTDOCFLAGS="--html-after-content docs-rs/trait-tags.html --cfg docsrs_dep" RUSTFLAGS="--cfg docsrs_dep" cargo doc --no-deps --package +``` + +[rustdoc]: https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html +[docs.rs]: https://docs.rs -- cgit v1.2.3