doc = include_str! readme

[clux]

minimal tests for the readme trying to follow: https://blog.guillaume-gomez.fr/articles/2021-08-03+Improvements+for+%23%5Bdoc%5D+attributes+in+Rust

adds a fake module under integration:

/// Doctests for CI
pub mod docs {
    /// Root README.md
    pub mod readme {
        #![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/../README.md"))]
    }
}

and then tries to get cargo test --doc --all to not complain

investigation thoughts irrelevant now

it gave me errors when i didn't have enough features on kube in the integration crate where i stashed it, but after that it doesn't complain about anything anymore :(

maybe it just doesn't parse the inline code blocks ...

maybe we need to use doc_comment instead like tokio. that is a heavily deprecated crate though..

EDIT: turns out it "works" with cargo test --doc --all...

[clux]

well, this kind of works now....had to basically do a huge amount of imports in the README to get cargo test --doc --all to like this, and didn't do all of them because you cannot hide the hidden imports and async wrappers in the main github display only inside cargo doc...

thus to actually do this, you would need all async wrappers, join crd examples, and have more imports than example code to have this in the README. and the github view of it would look terrible

don't think this is worth it... probably going to restructure the README at a later time, and move code out of the main README and maybe link directly to docs / examples.