search

JuliaDSP / DSP.jl

Filter design, periodograms, window functions, and other digital signal processing functionality
https://docs.juliadsp.org/dev/
Other
374 stars 108 forks source link

Doc issues on JuliaHub with 0.7.9 - Missing docstring. Check Documenter's build log for details. #547

Open scls19fr opened 4 months ago

scls19fr commented 4 months ago

Hello,

I noticed a lot of doc issues with 0.7.9

See

https://docs.juliahub.com/DSP/OtML7/0.7.9/windows/#DSP.Windows.hamming

we can see

Missing docstring.
Missing docstring for hamming. Check Documenter's build log for details.

and compare to

https://docs.juliahub.com/DSP/OtML7/0.7.8/windows/#DSP.Windows.hamming

Kind regards

martinholters commented 4 months ago

Oh, that's unfortunate. Looking at https://github.com/JuliaDSP/DSP.jl/compare/v0.7.8...v0.7.9 the only reason for the breakage that presents itself is the change in the CI setup and how it builds the docs, although that should in principle do the same as before. And the logs of the 0.7.9 run have been garbage-collected by now, so I don't know what went wrong there. The good news is that everything looks fine on master, so the docs for 0.8.0 should hopefully be ok again.

wheeheee commented 4 months ago

Also I think it's a JuliaHub only issue, the buttons to the docs on the GitHub README are fine, so you can refer to those.

martinholters commented 4 months ago

Ah, I had missed that those are JuliaHub links. So my comment above is moot.

scls19fr commented 4 months ago

Oh yes https://docs.juliadsp.org/stable/filters/ looks corrects