Merge pull request #10 from pop-os/docs-fixes

Fix doc build and add github test for it.

Author: 13r0ck

.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

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "cosmic-time"
-version = "0.1.0"
+version = "0.1.1"
 edition = "2021"
 description = "An animation Crate for Iced and Cosmic DE"
 license = "MIT"

README.md

@@ -1,5 +1,5 @@
 # COSMIC TIME
-## An animation toolkit for Iced-rs/Iced
+## An animation toolkit for [Iced](https://github.com/iced-rs/iced)
 
 > This Project was build for [Cosmic DE](https://github.com/pop-os/cosmic-epoch). Though this will work for any project that depends on [Iced](https://github.com/iced-rs/iced).
 
@@ -56,12 +56,12 @@ There are some different things here!
   > 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();
 
@@ -140,6 +140,9 @@ Done:
 - [x] Lazy keyframes. (Keyframes that can use the position of a previous (active or not) animation to start another animation.)
 
 TODOs:
+- [ ] Add container and space animiations between arbitraty length units.
+      Example: Length::Shrink to Length::Fixed(10.) and/or Length::Fill to Length::Shrink
+      Only fixed Length::Fixed(_) are supported currently.
 - [ ] Add `Cosmic` cargo feature for compatibility with both iced and System76's temporary fork.
 - [ ] Low motion accesability detection to disable animations.
 - [ ] general animation logic tests

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>>,

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,

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,

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,

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)
     }

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,

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)
     }