Skip to content

Documentation improvements + fixes #223

Documentation improvements + fixes

Documentation improvements + fixes #223

Triggered via pull request February 3, 2024 22:07
Status Failure
Total duration 3m 20s
Artifacts

CI.yml

on: pull_request
Documentation
2m 5s
Documentation
Matrix: test
Fit to window
Zoom out
Zoom in

Annotations

1 error and 14 warnings
Julia 1 - ubuntu-latest - x64 - pull_request
Process completed with exit code 1.
Julia 1 - ubuntu-latest - x64 - pull_request
Julia depot registries already exist. Skipping restoring of cached registries to avoid potential merge conflicts when updating. Please ensure that `julia-actions/cache` precedes any workflow steps which add registries.
Julia 1 - ubuntu-latest - x64 - pull_request
Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions/checkout@v2, actions/cache@4d4ae6ae148a43d0fd1eda1800170683e9882738, pyTooling/Actions/with-post-step@adef08d3bdef092282614f3b683897cefae82ee3, julia-actions/setup-julia@v1. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.
Julia 1 - ubuntu-latest - x64 - pull_request
The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
Documentation: ../../../.julia/packages/Documenter/1HwWe/src/utilities/utilities.jl#L46
no docs found for 'barycentric_coordinates' in `@docs` block in src/api.md:51-55 ```@docs barycentric_coordinates barycentric_coordinates! barycentric_interpolate ```
Documentation: ../../../.julia/packages/Documenter/1HwWe/src/utilities/utilities.jl#L46
no docs found for 'barycentric_coordinates!' in `@docs` block in src/api.md:51-55 ```@docs barycentric_coordinates barycentric_coordinates! barycentric_interpolate ```
Documentation: ../../../.julia/packages/Documenter/1HwWe/src/utilities/utilities.jl#L46
no docs found for 'barycentric_interpolate' in `@docs` block in src/api.md:51-55 ```@docs barycentric_coordinates barycentric_coordinates! barycentric_interpolate ```
Documentation: ../../../.julia/packages/Documenter/1HwWe/src/utilities/utilities.jl#L46
failed to run `@example` block in src/source/methods/barycentric.md:28-104 ```@example barycentric import GeometryOps as GO using GeometryOps.GeometryBasics using Makie using CairoMakie # Define a polygon polygon_points = Point3f[ (0.03, 0.05, 0.00), (0.07, 0.04, 0.02), (0.10, 0.04, 0.04), (0.14, 0.04, 0.06), (0.17, 0.07, 0.08), (0.20, 0.09, 0.10), (0.22, 0.11, 0.12), (0.25, 0.11, 0.14), (0.27, 0.10, 0.16), (0.30, 0.07, 0.18), (0.31, 0.04, 0.20), (0.34, 0.03, 0.22), (0.37, 0.02, 0.24), (0.40, 0.03, 0.26), (0.42, 0.04, 0.28), (0.44, 0.07, 0.30), (0.45, 0.10, 0.32), (0.46, 0.13, 0.34), (0.46, 0.19, 0.36), (0.47, 0.26, 0.38), (0.47, 0.31, 0.40), (0.47, 0.35, 0.42), (0.45, 0.37, 0.44), (0.41, 0.38, 0.46), (0.38, 0.37, 0.48), (0.35, 0.36, 0.50), (0.32, 0.35, 0.52), (0.30, 0.37, 0.54), (0.28, 0.39, 0.56), (0.25, 0.40, 0.58), (0.23, 0.39, 0.60), (0.21, 0.37, 0.62), (0.21, 0.34, 0.64), (0.23, 0.32, 0.66), (0.24, 0.29, 0.68), (0.27, 0.24, 0.70), (0.29, 0.21, 0.72), (0.29, 0.18, 0.74), (0.26, 0.16, 0.76), (0.24, 0.17, 0.78), (0.23, 0.19, 0.80), (0.24, 0.22, 0.82), (0.24, 0.25, 0.84), (0.21, 0.26, 0.86), (0.17, 0.26, 0.88), (0.12, 0.24, 0.90), (0.07, 0.20, 0.92), (0.03, 0.15, 0.94), (0.01, 0.10, 0.97), (0.02, 0.07, 1.00)] # Plot it! # First, we'll plot the polygon using Makie's rendering: f, a1, p1 = poly( polygon_points; color = last.(polygon_points), colormap = cgrad(:jet, 18; categorical = true), axis = (; type = Axis, aspect = DataAspect(), title = "Makie mesh based polygon rendering", subtitle = "CairoMakie" ), figure = (; size = (800, 400),) ) Makie.update_state_before_display!(f) # We have to call this explicitly, to get the axis limits correct # Now that we've plotted the first polygon, # we can render it using barycentric coordinates. a1_bbox = a1.finallimits[] # First we get the extent of the axis ext = GeometryOps.GI.Extent(NamedTuple{(:X, :Y)}(zip(minimum(a1_bbox), maximum(a1_bbox)))) a2 = Axis( f[1, 2], aspect = DataAspect(), title = "Barycentric coordinate based polygon rendering", subtitle = "GeometryOps", limits = (ext.X, ext.Y) ) p2box = poly!( # Now, we plot a cropping rectangle around the axis so we only show the polygon a2, GeometryOps.GeometryBasics.Polygon( # This is a rectangle with an internal hole shaped like the polygon. Point2f[(ext.X[1], ext.Y[1]), (ext.X[2], ext.Y[1]), (ext.X[2], ext.Y[2]), (ext.X[1], ext.Y[2]), (ext.X[1], ext.Y[1])], [reverse(Point2f.(polygon_points))] ); color = :white, xautolimits = false, yautolimits = false ) hidedecorations!(a1) hidedecorations!(a2) cb = Colorbar(f[2, :], p1.plots[1]; vertical = false, flipaxis = true) # Finally, we perform barycentric interpolation on a grid, xrange = LinRange(ext.X..., size(a2.scene)[1] * 4) # 2 rendered pixels per "physical" pixel yrange = LinRange(ext.Y..., size(a2.scene)[2] * 4) # 2 rendered pixels per "physical" pixel @time mean_values = barycentric_interpolate.( (MeanValue(),), # The barycentric coordinate algorithm (MeanValue is the only one for now) (Point2f.(polygon_points),), # The polygon points as `Point2f` (last.(polygon_points,),), # The values per polygon point - can be anything which supports addition and division Point2f.(xrange, yrange') # The points at which to interpolate ) # and render! hm = heatmap!( a2, xrange, yrange, mean_values; colormap = p1.colormap, # Use the same colormap as the original polygon plot colorrange = p1.plots[1].colorrange[], # Access the rendered mesh plot's colorrange directly transformation = (; translation = Vec3f(0,0,-1)), # This gets the heatmap to render "behind" the previously plotted polygon xautolimits = false, yautolimits = false ) f ``` exception = UndefVarError: `GeometryOps` not defined Stacktrace: [1] top-level scope @ barycentric.md:67 [2] eval @ ./boot.jl:385 [inlined] [3] #58 @ ~/.julia/packages/Documenter/1HwWe/src/expander_pipeline.jl:754 [inlined] [4] cd(f::Documenter.var"#58#60"{Module, E
Documentation: ../../../.julia/packages/Documenter/1HwWe/src/html/HTMLWriter.jl#L707
Unable to determine the repository root URL for the navbar link. This can happen when a string is passed to the `repo` keyword of `makedocs`. To remove this warning, either pass a Remotes.Remote object to `repo` to completely specify the remote repository, or explicitly set the remote URL by setting `repolink` via `makedocs(format = HTML(repolink = "..."), ...)`.
Documentation: ../../../.julia/packages/Documenter/1HwWe/src/html/HTMLWriter.jl#L1793
Generated HTML over size_threshold_warn limit: api.md Generated file size: 151.21 (KiB) size_threshold_warn: 100.0 (KiB) size_threshold: 200.0 (KiB) HTML file: api/index.html
Documentation
Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions/checkout@v2, actions/cache@4d4ae6ae148a43d0fd1eda1800170683e9882738, pyTooling/Actions/with-post-step@adef08d3bdef092282614f3b683897cefae82ee3, julia-actions/setup-julia@v1. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.
Documentation
The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/
Julia 1.6 - ubuntu-latest - x64 - pull_request
Julia depot registries already exist. Skipping restoring of cached registries to avoid potential merge conflicts when updating. Please ensure that `julia-actions/cache` precedes any workflow steps which add registries.
Julia 1.6 - ubuntu-latest - x64 - pull_request
Node.js 16 actions are deprecated. Please update the following actions to use Node.js 20: actions/checkout@v2, actions/cache@4d4ae6ae148a43d0fd1eda1800170683e9882738, pyTooling/Actions/with-post-step@adef08d3bdef092282614f3b683897cefae82ee3, julia-actions/setup-julia@v1. For more information see: https://github.blog/changelog/2023-09-22-github-actions-transitioning-from-node-16-to-node-20/.
Julia 1.6 - ubuntu-latest - x64 - pull_request
The following actions uses node12 which is deprecated and will be forced to run on node16: actions/checkout@v2. For more info: https://github.blog/changelog/2023-06-13-github-actions-all-actions-will-run-on-node16-instead-of-node12-by-default/