From d99f5665b420f570c4aa26602360f7d5eaee1dc9 Mon Sep 17 00:00:00 2001
From: Bram Geron <bram@bram.xyz>
Date: Tue, 25 Feb 2020 19:07:55 +0100
Subject: Rustdoc: Add links. Show all reexports as reexports. (#377)

* Rustdoc: Add links. Show all reexports as reexports.

* Reformat.
---
 src/lib.rs   | 23 +++++++++++++++--------
 src/value.rs |  1 +
 2 files changed, 16 insertions(+), 8 deletions(-)

(limited to 'src')

diff --git a/src/lib.rs b/src/lib.rs
index 4a32d71..6b02941 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -21,7 +21,7 @@
 //!
 //! ## TOML values
 //!
-//! A value in TOML is represented with the `Value` enum in this crate:
+//! A value in TOML is represented with the [`Value`] enum in this crate:
 //!
 //! ```rust,ignore
 //! pub enum Value {
@@ -35,13 +35,13 @@
 //! }
 //! ```
 //!
-//! TOML is similar to JSON with the notable addition of a `Datetime`
+//! TOML is similar to JSON with the notable addition of a [`Datetime`]
 //! type. In general, TOML and JSON are interchangeable in terms of
 //! formats.
 //!
 //! ## Parsing TOML
 //!
-//! The easiest way to parse a TOML document is via the `Value` type:
+//! The easiest way to parse a TOML document is via the [`Value`] type:
 //!
 //! ```rust
 //! use toml::Value;
@@ -51,9 +51,9 @@
 //! assert_eq!(value["foo"].as_str(), Some("bar"));
 //! ```
 //!
-//! The `Value` type implements a number of convenience methods and
-//! traits; the example above uses `FromStr` to parse a `str` into a
-//! `Value`.
+//! The [`Value`] type implements a number of convenience methods and
+//! traits; the example above uses [`FromStr`] to parse a [`str`] into a
+//! [`Value`].
 //!
 //! ## Deserialization and Serialization
 //!
@@ -70,8 +70,8 @@
 //! * `Deserializer for Value`
 //!
 //! This means that you can use Serde to deserialize/serialize the
-//! `Value` type as well as the `Datetime` type in this crate. You can also
-//! use the `Deserializer`, `Serializer`, or `Value` type itself to act as
+//! [`Value`] type as well as the [`Datetime`] type in this crate. You can also
+//! use the [`Deserializer`], [`Serializer`], or [`Value`] type itself to act as
 //! a deserializer/serializer for arbitrary types.
 //!
 //! An example of deserializing with TOML is:
@@ -171,4 +171,11 @@ mod tokens;
 pub mod macros;
 
 mod spanned;
+#[doc(no_inline)]
 pub use crate::spanned::Spanned;
+
+// Just for rustdoc
+#[allow(unused_imports)]
+use crate::datetime::Datetime;
+#[allow(unused_imports)]
+use core::str::FromStr;
diff --git a/src/value.rs b/src/value.rs
index 38dfe1f..e631efe 100644
--- a/src/value.rs
+++ b/src/value.rs
@@ -13,6 +13,7 @@ use serde::de::IntoDeserializer;
 use serde::ser;
 
 use crate::datetime::{self, DatetimeFromString};
+#[doc(no_inline)]
 pub use crate::datetime::{Datetime, DatetimeParseError};
 
 pub use crate::map::Map;
-- 
cgit v1.2.3