Fix doc build and add github test for it.

13r0ck · 13r0ck · commit 167548fe9c32 · 2023-03-28T16:23:52.000-06:00
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -0,0 +1,12 @@
+name: Docs
+on: [push, pull_request]
+jobs:
+  all:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: hecrj/setup-rust-action@v1
+      with:
+        components: clippy
+    - uses: actions/checkout@master
+    - name: Check Docs
+      run: cargo doc --workspace
diff --git a/examples/pong/src/layer.rs b/examples/pong/src/layer.rs
@@ -18,7 +18,7 @@ pub struct Layer<'a, Message, Renderer> {
 }
 
 impl<'a, Message, Renderer> Layer<'a, Message, Renderer> {
-    /// Returns a new [`Modal`]
+    /// Returns a new [`Layer`]
     pub fn new(
         base: impl Into<Element<'a, Message, Renderer>>,
         layer: impl Into<Element<'a, Message, Renderer>>,
diff --git a/src/keyframes/button.rs b/src/keyframes/button.rs
@@ -21,17 +21,17 @@ impl Id {
         Self(widget::Id::unique())
     }
 
-    /// Used by [`chain!`] macro
+    /// Used by [`crate::chain!`] macro
     pub fn into_chain(self) -> Chain {
         Chain::new(self)
     }
 
-    /// Used by [`chain!`] macro
+    /// Used by [`crate::chain!`] macro
     pub fn into_chain_with_children(self, children: Vec<Button>) -> Chain {
         Chain::with_children(self, children)
     }
 
-    /// Used by [`anim!`] macro
+    /// Used by [`crate::anim!`] macro
     pub fn as_widget<'a, Message, Renderer>(
         self,
         timeline: &crate::Timeline,
diff --git a/src/keyframes/column.rs b/src/keyframes/column.rs
@@ -21,17 +21,17 @@ impl Id {
         Self(widget::Id::unique())
     }
 
-    /// Used by [`chain!`] macro
+    /// Used by [`crate::chain!`] macro
     pub fn into_chain(self) -> Chain {
         Chain::new(self)
     }
 
-    /// Used by [`chain!`] macro
+    /// Used by [`crate::chain!`] macro
     pub fn into_chain_with_children(self, children: Vec<Column>) -> Chain {
         Chain::with_children(self, children)
     }
 
-    /// Used by [`anim!`] macro
+    /// Used by [`crate::anim!`] macro
     pub fn as_widget<'a, Message, Renderer>(
         self,
         timeline: &crate::Timeline,
diff --git a/src/keyframes/container.rs b/src/keyframes/container.rs
@@ -21,17 +21,17 @@ impl Id {
         Self(widget::Id::unique())
     }
 
-    /// Used by [`chain!`] macro
+    /// Used by [`crate::chain!`] macro
     pub fn into_chain(self) -> Chain {
         Chain::new(self)
     }
 
-    /// Used by [`chain!`] macro
+    /// Used by [`crate::chain!`] macro
     pub fn into_chain_with_children(self, children: Vec<Container>) -> Chain {
         Chain::with_children(self, children)
     }
 
-    /// Used by [`anim!`] macro
+    /// Used by [`crate::anim!`] macro
     pub fn as_widget<'a, Message, Renderer>(
         self,
         timeline: &crate::Timeline,
diff --git a/src/keyframes/helpers.rs b/src/keyframes/helpers.rs
@@ -2,43 +2,43 @@ use crate::keyframes::{Button, Column, Container, Row, Space, StyleButton, Style
 use crate::MovementType;
 
 /// Create a button keyframe.
-/// Needs to be added into a chain. See [`chain!`] macro.
+/// Needs to be added into a chain. See [`crate::chain!`] macro.
 pub fn button(at: impl Into<MovementType>) -> Button {
     Button::new(at)
 }
 
 /// Create a column keyframe.
-/// Needs to be added into a chain. See [`chain!`] macro.
+/// Needs to be added into a chain. See [`crate::chain!`] macro.
 pub fn column(at: impl Into<MovementType>) -> Column {
     Column::new(at)
 }
 
 /// Create a container keyframe.
-/// Needs to be added into a chain. See [`chain!`] macro.
+/// Needs to be added into a chain. See [`crate::chain!`] macro.
 pub fn container(at: impl Into<MovementType>) -> Container {
     Container::new(at)
 }
 
 /// Create a row keyframe.
-/// Needs to be added into a chain. See [`chain!`] macro.
+/// Needs to be added into a chain. See [`crate::chain!`] macro.
 pub fn row(at: impl Into<MovementType>) -> Row {
     Row::new(at)
 }
 
 /// Create a space keyframe.
-/// Needs to be added into a chain. See [`chain!`] macro.
+/// Needs to be added into a chain. See [`crate::chain!`] macro.
 pub fn space(at: impl Into<MovementType>) -> Space {
     Space::new(at)
 }
 
 /// Create a style_button keyframe.
-/// Needs to be added into a chain. See [`chain!`] macro.
+/// Needs to be added into a chain. See [`crate::chain!`] macro.
 pub fn style_button(at: impl Into<MovementType>) -> StyleButton {
     StyleButton::new(at)
 }
 
 /// Create a style_container keyframe.
-/// Needs to be added into a chain. See [`chain!`] macro.
+/// Needs to be added into a chain. See [`crate::chain!`] macro.
 pub fn style_container(at: impl Into<MovementType>) -> StyleContainer {
     StyleContainer::new(at)
 }
@@ -49,43 +49,43 @@ pub mod lazy {
     use crate::MovementType;
 
     /// Create a lazy button keyframe.
-    /// Needs to be added into a chain. See [`chain!`] macro.
+    /// Needs to be added into a chain. See [`crate::chain!`] macro.
     pub fn button(at: impl Into<MovementType>) -> Button {
         Button::lazy(at)
     }
 
     /// Create a lazy column keyframe.
-    /// Needs to be added into a chain. See [`chain!`] macro.
+    /// Needs to be added into a chain. See [`crate::chain!`] macro.
     pub fn column(at: impl Into<MovementType>) -> Column {
         Column::lazy(at)
     }
 
     /// Create a lazy container keyframe.
-    /// Needs to be added into a chain. See [`chain!`] macro.
+    /// Needs to be added into a chain. See [`crate::chain!`] macro.
     pub fn container(at: impl Into<MovementType>) -> Container {
         Container::lazy(at)
     }
 
     /// Create a lazy row keyframe.
-    /// Needs to be added into a chain. See [`chain!`] macro.
+    /// Needs to be added into a chain. See [`crate::chain!`] macro.
     pub fn row(at: impl Into<MovementType>) -> Row {
         Row::lazy(at)
     }
 
     /// Create a lazy space keyframe.
-    /// Needs to be added into a chain. See [`chain!`] macro.
+    /// Needs to be added into a chain. See [`crate::chain!`] macro.
     pub fn space(at: impl Into<MovementType>) -> Space {
         Space::lazy(at)
     }
 
     /// Create a lazy style_button keyframe.
-    /// Needs to be added into a chain. See [`chain!`] macro.
+    /// Needs to be added into a chain. See [`crate::chain!`] macro.
     pub fn style_button(at: impl Into<MovementType>) -> StyleButton {
         StyleButton::lazy(at)
     }
 
     /// Create a lazy style_container keyframe.
-    /// Needs to be added into a chain. See [`chain!`] macro.
+    /// Needs to be added into a chain. See [`crate::chain!`] macro.
     pub fn style_container(at: impl Into<MovementType>) -> StyleContainer {
         StyleContainer::lazy(at)
     }
diff --git a/src/keyframes/row.rs b/src/keyframes/row.rs
@@ -21,17 +21,17 @@ impl Id {
         Self(widget::Id::unique())
     }
 
-    /// Used by [`chain!`] macro
+    /// Used by [`crate::chain!`] macro
     pub fn into_chain(self) -> Chain {
         Chain::new(self)
     }
 
-    /// Used by [`chain!`] macro
+    /// Used by [`crate::chain!`] macro
     pub fn into_chain_with_children(self, children: Vec<Row>) -> Chain {
         Chain::with_children(self, children)
     }
 
-    /// Used by [`anim!`] macro
+    /// Used by [`crate::anim!`] macro
     pub fn as_widget<'a, Message, Renderer>(
         self,
         timeline: &crate::Timeline,
diff --git a/src/keyframes/space.rs b/src/keyframes/space.rs
@@ -21,17 +21,17 @@ impl Id {
         Self(widget::Id::unique())
     }
 
-    /// Used by [`chain!`] macro
+    /// Used by [`crate::chain!`] macro
     pub fn into_chain(self) -> Chain {
         Chain::new(self)
     }
 
-    /// Used by [`chain!`] macro
+    /// Used by [`crate::chain!`] macro
     pub fn into_chain_with_children(self, children: Vec<Space>) -> Chain {
         Chain::with_children(self, children)
     }
 
-    /// Used by [`anim!`] macro
+    /// Used by [`crate::anim!`] macro
     pub fn as_widget(self, timeline: &crate::Timeline) -> widget::Space {
         Space::as_widget(self, timeline)
     }
diff --git a/src/keyframes/style_button.rs b/src/keyframes/style_button.rs
@@ -22,17 +22,17 @@ impl Id {
         Self(widget::Id::unique())
     }
 
-    /// Used by [`chain!`] macro
+    /// Used by [`crate::chain!`] macro
     pub fn into_chain(self) -> Chain {
         Chain::new(self)
     }
 
-    /// Used by [`chain!`] macro
+    /// Used by [`crate::chain!`] macro
     pub fn into_chain_with_children(self, children: Vec<StyleButton>) -> Chain {
         Chain::with_children(self, children)
     }
 
-    /// Used by [`anim!`] macro
+    /// Used by [`crate::anim!`] macro
     pub fn as_widget<'a, Message, Renderer>(
         self,
         style: fn(u8) -> <Renderer::Theme as StyleSheet>::Style,
diff --git a/src/keyframes/style_container.rs b/src/keyframes/style_container.rs
@@ -22,17 +22,17 @@ impl Id {
         Self(widget::Id::unique())
     }
 
-    /// Used by [`chain!`] macro
+    /// Used by [`crate::chain!`] macro
     pub fn into_chain(self) -> Chain {
         Chain::new(self)
     }
 
-    /// Used by [`chain!`] macro
+    /// Used by [`crate::chain!`] macro
     pub fn into_chain_with_children(self, children: Vec<StyleContainer>) -> Chain {
         Chain::with_children(self, children)
     }
 
-    /// Used by [`anim!`] macro
+    /// Used by [`crate::anim!`] macro
     pub fn as_widget<'a, Message, Renderer>(
         self,
         style: fn(u8) -> <Renderer::Theme as StyleSheet>::Style,
diff --git a/src/lib.rs b/src/lib.rs
@@ -51,12 +51,12 @@
 //!
 //!   > let animation = chain![
 //!   Cosmic Time refers to animations as [`Chain`]s because of how we build then.
-//!   Each [`Keyframe`] is linked together like a chain. The Cosmic Time API doesn't
+//!   Each Keyframe is linked together like a chain. The Cosmic Time API doesn't
 //!   say "change your width from 10 to 100". We define each state we want the
 //!   widget to have `.width(10)` at `Duration::ZERO` then `.width(100)` at
 //!   `Duration::from_secs(10)`. Where the `Duration` is the time after the previous
-//!   [`keyframe`]. This is why we call the animations chains. We cannot get to the
-//!   next state without animating though all previous [`Keyframe`]s.
+//!   keyframe. This is why we call the animations chains. We cannot get to the
+//!   next state without animating though all previous Keyframes.
 //!
 //!   > self.timeline.set_chain(animation).start();
 //!   Then we need to add the animation to the [`Timeline`]. We call this `.set_chain`,
diff --git a/src/widget/container.rs b/src/widget/container.rs
@@ -127,7 +127,7 @@ where
         self
     }
 
-    /// Sets the animatable style variant of this [`Button`].
+    /// Sets the animatable style variant of this [`Container`].
     pub fn blend_style(
         mut self,
         style1: <Renderer::Theme as StyleSheet>::Style,

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ pub struct Layer<'a, Message, Renderer> {`
`18`	`18`	`}`
`19`	`19`
`20`	`20`	`impl<'a, Message, Renderer> Layer<'a, Message, Renderer> {`
`21`		- /// Returns a new [`Modal`]
	`21`	+ /// Returns a new [`Layer`]
`22`	`22`	`pub fn new(`
`23`	`23`	`base: impl Into<Element<'a, Message, Renderer>>,`
`24`	`24`	`layer: impl Into<Element<'a, Message, Renderer>>,`
Original file line number	Diff line number	Diff line change
`@@ -21,17 +21,17 @@ impl Id {`
`21`	`21`	`Self(widget::Id::unique())`
`22`	`22`	`}`
`23`	`23`
`24`		- /// Used by [`chain!`] macro
	`24`	+ /// Used by [`crate::chain!`] macro
`25`	`25`	`pub fn into_chain(self) -> Chain {`
`26`	`26`	`Chain::new(self)`
`27`	`27`	`}`
`28`	`28`
`29`		- /// Used by [`chain!`] macro
	`29`	+ /// Used by [`crate::chain!`] macro
`30`	`30`	`pub fn into_chain_with_children(self, children: Vec<Button>) -> Chain {`
`31`	`31`	`Chain::with_children(self, children)`
`32`	`32`	`}`
`33`	`33`
`34`		- /// Used by [`anim!`] macro
	`34`	+ /// Used by [`crate::anim!`] macro
`35`	`35`	`pub fn as_widget<'a, Message, Renderer>(`
`36`	`36`	`self,`
`37`	`37`	`timeline: &crate::Timeline,`
Original file line number	Diff line number	Diff line change
`@@ -22,17 +22,17 @@ impl Id {`
`22`	`22`	`Self(widget::Id::unique())`
`23`	`23`	`}`
`24`	`24`
`25`		- /// Used by [`chain!`] macro
	`25`	+ /// Used by [`crate::chain!`] macro
`26`	`26`	`pub fn into_chain(self) -> Chain {`
`27`	`27`	`Chain::new(self)`
`28`	`28`	`}`
`29`	`29`
`30`		- /// Used by [`chain!`] macro
	`30`	+ /// Used by [`crate::chain!`] macro
`31`	`31`	`pub fn into_chain_with_children(self, children: Vec<StyleButton>) -> Chain {`
`32`	`32`	`Chain::with_children(self, children)`
`33`	`33`	`}`
`34`	`34`
`35`		- /// Used by [`anim!`] macro
	`35`	+ /// Used by [`crate::anim!`] macro
`36`	`36`	`pub fn as_widget<'a, Message, Renderer>(`
`37`	`37`	`self,`
`38`	`38`	`style: fn(u8) -> <Renderer::Theme as StyleSheet>::Style,`