Skip to content

Fix documentation publishing issue#160

Merged
lostella merged 2 commits into
JuliaFirstOrder:masterfrom
hakkelt:fix-documentation
Jul 13, 2026
Merged

Fix documentation publishing issue#160
lostella merged 2 commits into
JuliaFirstOrder:masterfrom
hakkelt:fix-documentation

Conversation

@hakkelt

@hakkelt hakkelt commented Jun 2, 2026

Copy link
Copy Markdown
Contributor

This PR replaces the explicit call to docs/make.jl in docs.yml (recommended by Documenter's documentation) with a specialized GitHub action: https://github.com/julia-actions/julia-docdeploy#usage

This GitHub action seems curated (it is part of julia-actions organization) and maintained (last commit was 6 month ago).

It might fix #155 because it doesn't require DOCUMENTER_KEY variable to be set up.

@hakkelt

hakkelt commented Jun 16, 2026

Copy link
Copy Markdown
Contributor Author

Hi @lostella, could you review this?

@github-actions

Copy link
Copy Markdown
Contributor

Benchmark Results (Julia v1)

Time benchmarks
master f65693c... master / f65693c...
IndBallL1/Float32 3.81 ± 0.45 μs 3.99 ± 0.45 μs 0.955 ± 0.16
IndBallL1/Float64 4.9 ± 1.6 μs 4.97 ± 1.6 μs 0.986 ± 0.45
IndBox/Float32 9.16 ± 0.08 μs 9.22 ± 0.13 μs 0.993 ± 0.016
IndBox/Float64 9.35 ± 0.47 μs 9.83 ± 0.48 μs 0.951 ± 0.067
IndExpPrimal/Float32 0.197 ± 0.011 ms 0.202 ± 0.01 ms 0.974 ± 0.074
IndExpPrimal/Float64 0.198 ± 0.012 ms 0.202 ± 0.011 ms 0.979 ± 0.08
IndNonnegative/Float32 9.64 ± 1.4 μs 11.2 ± 1.8 μs 0.86 ± 0.19
IndNonnegative/Float64 5.27 ± 0.27 μs 5.42 ± 0.35 μs 0.972 ± 0.08
IndPSD/("ComplexF64", 10) 18.5 ± 1.4 μs 18.6 ± 1.4 μs 0.993 ± 0.11
IndPSD/("ComplexF64", 20) 0.0699 ± 0.0017 ms 0.0697 ± 0.0008 ms 1 ± 0.027
IndPSD/("ComplexF64", 50) 0.555 ± 0.015 ms 0.555 ± 0.013 ms 1 ± 0.035
IndPSD/("Float64", 10) 14.7 ± 0.57 μs 14.7 ± 0.62 μs 0.994 ± 0.057
IndPSD/("Float64", 20) 0.0474 ± 0.0035 ms 0.0476 ± 0.00066 ms 0.998 ± 0.075
IndPSD/("Float64", 50) 0.281 ± 0.011 ms 0.282 ± 0.011 ms 0.997 ± 0.057
IndSimplex/Float32 22.2 ± 0.59 μs 21.4 ± 0.6 μs 1.04 ± 0.04
IndSimplex/Float64 27.5 ± 2.9 μs 27.4 ± 2.9 μs 1 ± 0.15
LeastSquares/("ComplexF64", "(11, 5)", 0, 0) 1.11 ± 0.02 μs 1.11 ± 0.01 μs 0.999 ± 0.02
LeastSquares/("ComplexF64", "(11, 5)", 0, 1) 1.49 ± 0.05 μs 1.51 ± 0.04 μs 0.987 ± 0.042
LeastSquares/("ComplexF64", "(11, 5)", 1, 0) 9.77 ± 0.29 μs 10 ± 0.35 μs 0.973 ± 0.045
LeastSquares/("ComplexF64", "(11, 5)", 1, 1) 1.48 ± 0.051 μs 1.45 ± 0.041 μs 1.02 ± 0.045
LeastSquares/("ComplexF64", "(5, 11)", 0, 0) 1.31 ± 0.02 μs 1.3 ± 0.02 μs 1.01 ± 0.022
LeastSquares/("ComplexF64", "(5, 11)", 0, 1) 1.68 ± 0.05 μs 1.7 ± 0.05 μs 0.988 ± 0.041
LeastSquares/("ComplexF64", "(5, 11)", 1, 0) 9.98 ± 0.29 μs 10.3 ± 0.34 μs 0.964 ± 0.042
LeastSquares/("ComplexF64", "(5, 11)", 1, 1) 1.72 ± 0.09 μs 1.67 ± 0.071 μs 1.03 ± 0.069
LeastSquares/("Float64", "(11, 5)", 0, 0) 0.972 ± 0.03 μs 0.982 ± 0.011 μs 0.99 ± 0.032
LeastSquares/("Float64", "(11, 5)", 0, 1) 1.26 ± 0.051 μs 1.24 ± 0.06 μs 1.02 ± 0.064
LeastSquares/("Float64", "(11, 5)", 1, 0) 9.57 ± 0.24 μs 9.6 ± 0.25 μs 0.997 ± 0.036
LeastSquares/("Float64", "(11, 5)", 1, 1) 1.2 ± 0.06 μs 1.19 ± 0.07 μs 1.01 ± 0.078
LeastSquares/("Float64", "(5, 11)", 0, 0) 1.15 ± 0.02 μs 1.16 ± 0.02 μs 0.991 ± 0.024
LeastSquares/("Float64", "(5, 11)", 0, 1) 1.41 ± 0.04 μs 1.42 ± 0.04 μs 0.993 ± 0.04
LeastSquares/("Float64", "(5, 11)", 1, 0) 9.82 ± 0.25 μs 9.83 ± 0.26 μs 0.999 ± 0.037
LeastSquares/("Float64", "(5, 11)", 1, 1) 1.42 ± 0.06 μs 1.36 ± 0.051 μs 1.04 ± 0.059
NormL2/Float32 4.14 ± 0.69 μs 4.47 ± 0.32 μs 0.926 ± 0.17
NormL2/Float64 10.3 ± 3.4 μs 11.2 ± 2.6 μs 0.92 ± 0.37
time_to_load 1.03 ± 0.0071 s 1.02 ± 0.0021 s 1 ± 0.0072
Memory benchmarks
master f65693c... master / f65693c...
IndBallL1/Float32 10 allocs: 10.4 kB 10 allocs: 10.4 kB 1
IndBallL1/Float64 10 allocs: 20.5 kB 10 allocs: 20.5 kB 1
IndBox/Float32 1 allocs: 16 B 1 allocs: 16 B 1
IndBox/Float64 1 allocs: 16 B 1 allocs: 16 B 1
IndExpPrimal/Float32 11 k allocs: 0.179 MB 11 k allocs: 0.179 MB 1
IndExpPrimal/Float64 11 k allocs: 0.179 MB 11 k allocs: 0.179 MB 1
IndNonnegative/Float32 1 allocs: 16 B 1 allocs: 16 B 1
IndNonnegative/Float64 1 allocs: 16 B 1 allocs: 16 B 1
IndPSD/("ComplexF64", 10) 19 allocs: 11.9 kB 19 allocs: 11.9 kB 1
IndPSD/("ComplexF64", 20) 22 allocs: 29.2 kB 22 allocs: 29.2 kB 1
IndPSD/("ComplexF64", 50) 23 allocs: 0.116 MB 23 allocs: 0.116 MB 1
IndPSD/("Float64", 10) 16 allocs: 5.88 kB 16 allocs: 5.88 kB 1
IndPSD/("Float64", 20) 18 allocs: 14 kB 18 allocs: 14 kB 1
IndPSD/("Float64", 50) 19 allocs: 0.0564 MB 19 allocs: 0.0564 MB 1
IndSimplex/Float32 24 allocs: 0.0344 MB 24 allocs: 0.0344 MB 1
IndSimplex/Float64 26 allocs: 0.0685 MB 26 allocs: 0.0685 MB 1
LeastSquares/("ComplexF64", "(11, 5)", 0, 0) 7 allocs: 1.05 kB 7 allocs: 1.05 kB 1
LeastSquares/("ComplexF64", "(11, 5)", 0, 1) 17 allocs: 1.14 kB 17 allocs: 1.14 kB 1
LeastSquares/("ComplexF64", "(11, 5)", 1, 0) 0.059 k allocs: 4.6 kB 0.059 k allocs: 4.6 kB 1
LeastSquares/("ComplexF64", "(11, 5)", 1, 1) 17 allocs: 1.17 kB 17 allocs: 1.17 kB 1
LeastSquares/("ComplexF64", "(5, 11)", 0, 0) 7 allocs: 1.05 kB 7 allocs: 1.05 kB 1
LeastSquares/("ComplexF64", "(5, 11)", 0, 1) 17 allocs: 1.14 kB 17 allocs: 1.14 kB 1
LeastSquares/("ComplexF64", "(5, 11)", 1, 0) 0.059 k allocs: 4.6 kB 0.059 k allocs: 4.6 kB 1
LeastSquares/("ComplexF64", "(5, 11)", 1, 1) 17 allocs: 1.17 kB 17 allocs: 1.17 kB 1
LeastSquares/("Float64", "(11, 5)", 0, 0) 7 allocs: 0.609 kB 7 allocs: 0.609 kB 1
LeastSquares/("Float64", "(11, 5)", 0, 1) 17 allocs: 0.984 kB 17 allocs: 0.984 kB 1
LeastSquares/("Float64", "(11, 5)", 1, 0) 0.059 k allocs: 3.96 kB 0.059 k allocs: 3.96 kB 1
LeastSquares/("Float64", "(11, 5)", 1, 1) 17 allocs: 1.02 kB 17 allocs: 1.02 kB 1
LeastSquares/("Float64", "(5, 11)", 0, 0) 7 allocs: 0.609 kB 7 allocs: 0.609 kB 1
LeastSquares/("Float64", "(5, 11)", 0, 1) 17 allocs: 0.984 kB 17 allocs: 0.984 kB 1
LeastSquares/("Float64", "(5, 11)", 1, 0) 0.059 k allocs: 3.96 kB 0.059 k allocs: 3.96 kB 1
LeastSquares/("Float64", "(5, 11)", 1, 1) 17 allocs: 1.02 kB 17 allocs: 1.02 kB 1
NormL2/Float32 1 allocs: 16 B 1 allocs: 16 B 1
NormL2/Float64 1 allocs: 16 B 1 allocs: 16 B 1
time_to_load 0.145 k allocs: 11 kB 0.145 k allocs: 11 kB 1

@lostella

Copy link
Copy Markdown
Member

Looks like #161 worked 🎉

@lostella lostella enabled auto-merge (squash) July 13, 2026 07:58
@lostella lostella merged commit ccfc1c0 into JuliaFirstOrder:master Jul 13, 2026
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation fails pushing

2 participants