Fixing docs (#281)

* update makedocs docs * fixes
JuliaIO · Nov 23, 2020 · c128fca · c128fca
1 parent 79b9b9e
commit c128fca
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 8 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,5 +1,2 @@
 [deps]
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
-
-[compat]
-Documenter = "~0.22"
diff --git a/docs/make.jl b/docs/make.jl
@@ -4,8 +4,11 @@ makedocs(
     modules = [VideoIO],
     format = Documenter.HTML(
         assets = ["assets/favicon.ico"],
-        analytics = "UA-143027902-2"),
+        analytics = "UA-143027902-2",
+        canonical = "https://juliaio.github.io/VideoIO.jl/stable/",
+    ),
     sitename="VideoIO.jl",
+
     pages    = Any[
         "Introduction"             => "index.md",
         "Reading Videos"           => "reading.md",
@@ -17,4 +20,5 @@ makedocs(
     )
 deploydocs(
     repo = "github.com/JuliaIO/VideoIO.jl.git",
+    push_preview = true
 )
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -2,11 +2,11 @@
 
 This library provides methods for reading and writing video files.
 
-Functionality is based on a dedicated build of ffmpeg 4.1, provided via [FFMPEGBuilder](https://github.com/JuliaIO/FFMPEGBuilder)
+Functionality is based on a dedicated build of ffmpeg, provided via [JuliaPackaging/Yggdrasil](https://github.com/JuliaPackaging/Yggdrasil/tree/master/F/FFMPEG)
 
 Explore the source at [github.com/JuliaIO/VideoIO.jl](https://github.com/JuliaIO/VideoIO.jl)
 
-### Platform Nodes: 
+### Platform Nodes:
 
 - ARM: For truly lossless reading & writing, there is a known issue on ARM that results in small precision differences when reading/writing some video files. As such, tests for frame comparison are currently skipped on ARM. Issues/PRs welcome for helping to get this fixed.
 

diff --git a/docs/src/reading.md b/docs/src/reading.md
@@ -29,7 +29,7 @@ Alternatively, you can open the video stream in a file directly with
 `VideoIO.openvideo(filename)`, without making an intermediate `AVInput`
 object, if you only need the video.
 
-VideoIO also provides an iterator interface for [`VideoReader`](@ref), which
+VideoIO also provides an iterator interface for `VideoReader`, which
 behaves like other mutable iterators in Julia (e.g. Channels). If iteration is
 stopped early, for example with a `break` statement, then it can be resumed in
 the same spot by iterating on the same `VideoReader` object. Consequently, if
@@ -77,7 +77,7 @@ Total available frame count is available via `counttotalframes(f)`
 VideoIO.counttotalframes
 ```
 
-!!! note H264 videos encoded with `crf>0` have been observed to have 4-fewer frames 
+!!! note H264 videos encoded with `crf>0` have been observed to have 4-fewer frames
 available for reading.
 
 ### Changing the target pixel format for reading