silent errors aren't passing...

dsweber2 · dsweber2 · commit f7750c932578 · 2021-04-22T15:10:02.000-07:00
diff --git a/.github/workflows/docsBuild.yml b/.github/workflows/docsBuild.yml
@@ -10,25 +10,26 @@ on:
     - docs/*
     - Project.toml
 jobs:
-  docs:
-    name: Documentation
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: julia-actions/setup-julia@latest
-        with:
-          version: '1.6'
-      - name: Install dependencies
-        run: |
-          sudo apt install libxt6 libxrender1 libxext6 libgl1-mesa-glx libqt5widgets5
-      - run: |
-          julia --project=docs -e '
-            using Pkg
-            Pkg.instantiate()
-            Pkg.develop(PackageSpec(path=pwd()))
-            Pkg.instantiate()'
-      - name: Build and deploy
-        run: julia --project=docs docs/make.jl
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+  name: Documentation
+  runs-on: ubuntu-latest
+  steps:
+    - uses: actions/checkout@v2
+    - uses: julia-actions/setup-julia@latest
+      with:
+        version: '1.6'
+    - name: Install dependencies
+      run: |
+        sudo apt install libxt6 libxrender1 libxext6 libgl1-mesa-glx libqt5widgets5
+      run: |
+        julia --project=docs -e '
+          using Pkg
+          Pkg.instantiate()
+          Pkg.develop(PackageSpec(path=pwd()))
+          Pkg.instantiate()'
+    - name: Build and deploy
+      env:
+        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
+      run: julia --project=docs --code-coverage=user docs/make.jl
+    - uses: julia-actions/julia-processcoverage@v1
+    - uses: codecov/codecov-action@v1
diff --git a/README.md b/README.md
@@ -3,6 +3,7 @@
 [![Build Status](https://travis-ci.com/dsweber2/ContinuousWavelets.jl.svg?branch=master)](https://travis-ci.com/dsweber2/ContinuousWavelets.jl)
 [![Coverage](https://codecov.io/gh/dsweber2/ContinuousWavelets.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/dsweber2/ContinuousWavelets.jl)
 [![](https://img.shields.io/badge/docs-dev-blue.svg)](https://dsweber2.github.io/ContinuousWavelets.jl/dev/)
+
 This package is an offshoot of [Wavelets.jl](https://github.com/JuliaDSP/Wavelets.jl) for the continuous wavelets.
 Thanks to [Felix Gerick](https://github.com/fgerick) for the initial implementation there, with extension and further adaptation by David Weber and any other contributors listed on the right.
 Currently, it implements 1D continuous wavelet transforms with the following mother wavelets:
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,13 +1,16 @@
 using Documenter, ContinuousWavelets
 ENV["GKSwstype"] = "100"
 makedocs(sitename="ContinuousWavelets.jl",
+         format=Documenter.HTML(),
+         authors="David Weber",
+         clean=true,
          pages=[
              "basic usage" => "index.md",
              "Install" => "installation.md",
              "CWT" => [
                  "Available Wavelet Families" => "coreType.md",
                  "CWT Construction" => "CWTConstruction.md",
-                 "Wavelet Spacing" => "spacing.md",
+                 "Wavelet Frequency Spacing" => "spacing.md",
                  "Boundary Conditions" => "bound.md",
                  "Inversion" => "inverse.md"
              ],
diff --git a/docs/src/CWTConstruction.md b/docs/src/CWTConstruction.md
@@ -1,4 +1,4 @@
-# CWT type
+# CWT Construction
 ```@docs
 CWT
 ContinuousWavelets.wavelet(::WC) where {WC<:ContinuousWavelets.ContWaveClass}
@@ -10,7 +10,7 @@ The function `wavelet()` has been overloaded to work with ContWaveClass in much
 In more detail, the parameters, along with their defaults, are:
 + `wave::ContWaveClass`: is a type of continuous wavelet, see the [Available Wavelet Families](@ref).
 + `scalingFactor`, `s`, or `Q::Real=8.0`: the number of wavelets between the octaves ``2^J`` and ``2^{J+1}`` (defaults to 8, which is most appropriate for music and other audio). Valid range is $(0,\infty)$.
-+ `β::Real=4.0`: As using exactly `Q` wavelets per octave leads to excessively many low-frequency wavelets, `β` varies the number of wavelets per octave, with larger values of `β` corresponding to fewer low frequency wavelets(see [Wavelet Spacing](@ref) for details).
++ `β::Real=4.0`: As using exactly `Q` wavelets per octave leads to excessively many low-frequency wavelets, `β` varies the number of wavelets per octave, with larger values of `β` corresponding to fewer low frequency wavelets(see [Wavelet Frequency Spacing](@ref) for details).
   Valid range is $(1,\infty)$, though around `β=6` the spacing is approximately linear *in frequency*, rather than log-frequency, and begins to become concave after that.
 + `boundary::WaveletBoundary=SymBoundary()`: The default boundary condition is `SymBoundary()`, implemented by appending a flipped version of the vector at the end to eliminate edge discontinuities. See [Boundary Conditions](@ref) for the other possibilities. 
 + `averagingType::Average=Father()`: determines whether or not to include the
diff --git a/docs/src/bound.md b/docs/src/bound.md
@@ -1,4 +1,4 @@
-# Boundary types #
+# Boundary Conditions #
 
 ```@docs 
 WaveletBoundary
diff --git a/docs/src/coreType.md b/docs/src/coreType.md
@@ -1,4 +1,4 @@
-# Wavelet types
+# Available Wavelet Families
 There are two tiers of wavelet types in this package. The most abstract is the `ContWave` type, representing a class of wavelets.
 This is split into several strictly continuous wavelets, and a `ContOrtho<:ContWave` type, which is a supertype of continuous versions of the orthogonal wavelets defined in [Wavelets.jl](https://github.com/JuliaDSP/Wavelets.jl).
 ```@docs
@@ -9,7 +9,6 @@ ContWave
 using ContinuousWavelets, Plots, Wavelets, FFTW, Logging
 using Plots; gr()
 Plots.reset_defaults()
-global_logger(Logging.SimpleLogger(stderr,Logging.Error))
 n= 2047;
 function mapTo(waveType, isReal=true,window=1:2047; d=1, kwargs...)
 	if isReal
diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,26 +1,19 @@
 # ContinuousWavelets Documentation #
-Originally included in Wavelets.jl, this is a fork containing the types and
-methods specifically for doing continuous wavelet transforms. Current methods
-only include 1D wavelet transforms and their inverses.
+Originally included in Wavelets.jl, this is a fork containing the types and methods specifically for doing continuous wavelet transforms. Current methods only include 1D wavelet transforms and their inverses.
 
-The basic structure is similar to that of Wavelets.jl; first you choose one of
-the ![Wavelet types](@ref) of the `ContWaveClass` type, e.g. `Morlet(2π)`.
-Then you set the general transform parameters by constructing a ![CWT
-type](@ref), which specifies such properties as whether to average,
-the scaling rate, or the boundary conditions. Finally, you perform the actual
-transform with`cwt`.
+The basic structure is similar to that of Wavelets.jl; first you choose one of the [Available Wavelet Families](@ref) of the `ContWaveClass` type, e.g. `Morlet(2π)`.
+Then you set the general transform parameters via [CWT Construction](@ref), which specifies such properties as whether to average, the scaling rate, or the boundary conditions.
+Finally, you perform the actual transform with`cwt`.
 
 ```@example basicEx
 using Plots; gr(); #hide
 Plots.reset_defaults(); #hide
 using ContinuousWavelets, Plots, Wavelets, FFTW
-using Logging #hide
-global_logger(Logging.SimpleLogger(stderr,Logging.Error)) #hide
 n=2047;
 f = testfunction(n, "Doppler");
 p1=plot(f,legend=false,title="Doppler",xlims=(0,2000));
 c = wavelet(Morlet(π), averagingType=NoAve(), β=2);
-res = cwt(f, c)
+res = ContinuousWavelets.cwt(f, c)
 p2=heatmap(abs.(res)', xlabel= "time index", 
 	ylabel="frequency index",colorbar=false);
 l=@layout [a{.3h};b{.7h}]
diff --git a/docs/src/inverse.md b/docs/src/inverse.md
@@ -2,7 +2,6 @@
 using ContinuousWavelets, Plots, Wavelets, FFTW, Logging
 using Plots; gr()
 Plots.reset_defaults()
-global_logger(Logging.SimpleLogger(stderr,Logging.Error))
 ```
 # Wavelet Inversion #
 The continuous wavelet transform is a redundant shift-invariant frame transform. As such, there isn't a single inverse transform, although there is a canonical pseudo-inverse. For more see, for example, chapter 5 of [A Wavelet Tour of Signal Processing](https://wavelet-tour.github.io/).
diff --git a/docs/src/spacing.md b/docs/src/spacing.md
@@ -1,4 +1,4 @@
-# Wavelet Frequency spacing #
+# Wavelet Frequency Spacing #
 Frequently, using a fixed ratio for scaling the wavelets results in too many large scale wavelets.
 There are several ways of dealing with this; in this package, the scaling factors have the form $2^{a(mx+x_0)^{^1/_\beta}}$, for suitable choice of $a$,$m$, $x_0$, and $\beta$.
 The user chooses $\beta$ and $Q$, and the rest are chosen to match the derivative at the last frequency to be $^{1}/_{Q}$, as in the figure.
@@ -7,7 +7,6 @@ The user chooses $\beta$ and $Q$, and the rest are chosen to match the derivativ
 using ContinuousWavelets, Plots, Wavelets, FFTW, LaTeXStrings, Logging
 using Plots; gr();
 Plots.reset_defaults();
-global_logger(Logging.SimpleLogger(stderr,Logging.Error))
 dRate = 4
 waveType = Morlet()
 Ψ1 = wavelet(waveType, s=8, β =dRate, averagingLength=2)

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Boundary types #`
	`1`	`+# Boundary Conditions #`
`2`	`2`
`3`	`3`	```@docs
`4`	`4`	`WaveletBoundary`