chore: Fix warnings during docs build

and make sure that `cross_toml` shows up as part of the official
documentation along the way.

Author: har7an

src/cross_toml.rs

@@ -1,4 +1,9 @@
-#![doc = include_str!("../docs/config_file.md")]
+//! The `Cross.toml` configuration file.
+//!
+//! For a detailed user documentation of the file and the contents please refer to the [docs in the
+//! repo][1].
+//!
+//! [1]: https://github.com/har7an/cross/blob/docs/restructure-docs-folder/docs/config_file.md
 
 use crate::docker::custom::PreBuild;
 use crate::docker::PossibleImage;

src/docker/engine.rs

@@ -51,7 +51,7 @@ impl EngineType {
     /// Some container engines, especially podman, do not support the `type`
     /// key of `--cache-from` during the image build steps. They also do
     /// not support any tags for the `--cache-from` steps either. See:
-    /// https://docs.podman.io/en/latest/markdown/podman-build.1.html#cache-from
+    /// <https://docs.podman.io/en/latest/markdown/podman-build.1.html#cache-from>
     #[must_use]
     pub const fn supports_cache_from_type(&self) -> bool {
         matches!(self, Self::Docker | Self::Nerdctl)

src/docker/image.rs

@@ -103,7 +103,7 @@ impl std::fmt::Display for PossibleImage {
 }
 /// The architecture/platform to use in the image
 ///
-/// https://github.com/containerd/containerd/blob/release/1.6/platforms/platforms.go#L63
+/// <https://github.com/containerd/containerd/blob/release/1.6/platforms/platforms.go#L63>
 #[derive(Debug, Clone, PartialEq, Eq, serde::Deserialize)]
 #[serde(try_from = "String")]
 pub struct ImagePlatform {

src/lib.rs

@@ -8,7 +8,8 @@
 //! <strong>⚠️ Warning:</strong> The cross library is for internal
 //! use only: only the command-line interface is stable. The library
 //! may change at any point for any reason. For documentation on the
-//! CLI, please see the repository <a href="https://github.com/cross-rs/cross">README</a>
+//! CLI, please see the repository <a href="https://github.com/cross-rs/cross">README</a>,
+//! <a href="https://github.com/cross-rs/cross/tree/main/docs">docs folder</a>
 //! or the <a href="https://github.com/cross-rs/cross/wiki">wiki</a>.
 //! </p>
 
@@ -33,7 +34,7 @@ mod tests;
 pub mod cargo;
 pub mod cli;
 pub mod config;
-mod cross_toml;
+pub mod cross_toml;
 pub mod docker;
 pub mod errors;
 mod extensions;