xilem

History

Kaur Kuut 419f8f115e Match CI doc testing with docs.rs. (#726 ) * Treat doc warnings as errors. Historically we've not done so due to various `rustdoc` bugs giving false positives but I got it to pass without failure right now, so perhaps better times have arrived. * Target only `x86_64-unknown-linux-gnu` on docs.rs as we don't have any platform specific docs. * Properly enable example scraping for `xilem`, `xilem_core`, and `masonry`. Fully disable it for `xilem_web` which does not have examples as Cargo defines them. * Pass `--all-features` at docs.rs to match our CI and reduce the maintenance burden of manually syncing the features list. * Enable the `doc_auto_cfg` feature for docs.rs which will show a little tip next to feature gated functionality informing of the crate feature flag. * Replaced `[!TIP]` with `💡 Tip` that was inside `<div class="rustdoc-hidden" />`. The GitHub specific tip causes a `rustdoc` error and [didn't even render properly](`ac2ca38785/masonry/src/doc/01_creating_app.md`). * Updated `01_creating_app.md` just enough to get `rustdoc` to pass, but that file needs a bunch of more work, as it is outdated.	2024-11-05 11:25:36 +00:00
..
workflows	Match CI doc testing with docs.rs. (#726 )	2024-11-05 11:25:36 +00:00
copyright.sh	Standardize copyright headers. (#246 )	2024-05-03 08:50:39 +00:00

Match CI doc testing with docs.rs. (#726 )

* Treat doc warnings as errors. Historically we've not done so due to
various `rustdoc` bugs giving false positives but I got it to pass
without failure right now, so perhaps better times have arrived.
* Target only `x86_64-unknown-linux-gnu` on docs.rs as we don't have any
platform specific docs.
* Properly enable example scraping for `xilem`, `xilem_core`, and
`masonry`. Fully disable it for `xilem_web` which does not have examples
as Cargo defines them.
* Pass `--all-features` at docs.rs to match our CI and reduce the
maintenance burden of manually syncing the features list.
* Enable the `doc_auto_cfg` feature for docs.rs which will show a little
tip next to feature gated functionality informing of the crate feature
flag.
* Replaced `[!TIP]` with `💡 Tip` that was inside `<div
class="rustdoc-hidden" />`. The GitHub specific tip causes a `rustdoc`
error and [didn't even render
properly](ac2ca38785/masonry/src/doc/01_creating_app.md).
* Updated `01_creating_app.md` just enough to get `rustdoc` to pass, but
that file needs a bunch of more work, as it is outdated.

2024-11-05 11:25:36 +00:00

workflows Match CI doc testing with docs.rs. (#726 ) 2024-11-05 11:25:36 +00:00