Match CI doc testing with docs.rs. #726
Conversation
| @@ -5,7 +5,7 @@ | |||
|
|
|||
| <div class="rustdoc-hidden"> | |||
|
|
|||
| > [!TIP] | |||
| > 💡 Tip | |||
There was a problem hiding this comment.
:( - this rendering is appreciably less obvious, but I can understand the motivation
Moving the <div class="rustdoc-hidden"> into mod.rs should work, if we use the following:
That does move the title below the tip, but that might be just as fine - we don't expect too many people to view it in-situ.
<!-- Copyright 2024 the Xilem Authors -->
<!-- SPDX-License-Identifier: Apache-2.0 -->
> [!TIP]
>
> This file is intended to be read in rustdoc.
> Use `cargo doc --open --package masonry --no-deps`.
</div>
# Building a "To-Do List" appLeaving it this way is also fine, to be clear.
There was a problem hiding this comment.
Well it's better than status quo.
Moving <div class="rustdoc-hidden"> might work indeed, but I'll leave that exercise to someone else as it's orthogonal to my current focus of CI.
| features = ["kurbo"] | ||
| [[example]] | ||
| name = "user_interface" | ||
| # This actually enables scraping for all examples, not just this one. |
There was a problem hiding this comment.
Very much so, but I guess it's not stabilized yet so they're going with it.
| # rustdoc-scrape-examples tracking issue https://github.com/rust-lang/rust/issues/88791 | ||
| cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"] | ||
|
|
||
| [[example]] | ||
| name = "mason" | ||
| # This actually enables scraping for all examples, not just this one. | ||
| # However it is possible to set doc-scrape-examples to false for other specific examples. | ||
| doc-scrape-examples = true |
There was a problem hiding this comment.
Do we need to disable this for the _android examples?
There was a problem hiding this comment.
Thankfully it's smart enough to not duplicate the examples, so no.
rustdocbugs giving false positives but I got it to pass without failure right now, so perhaps better times have arrived.x86_64-unknown-linux-gnuon docs.rs as we don't have any platform specific docs.xilem,xilem_core, andmasonry. Fully disable it forxilem_webwhich does not have examples as Cargo defines them.--all-featuresat docs.rs to match our CI and reduce the maintenance burden of manually syncing the features list.doc_auto_cfgfeature for docs.rs which will show a little tip next to feature gated functionality informing of the crate feature flag.[!TIP]with💡 Tipthat was inside<div class="rustdoc-hidden" />. The GitHub specific tip causes arustdocerror and didn't even render properly.01_creating_app.mdjust enough to getrustdocto pass, but that file needs a bunch of more work, as it is outdated.