From 8f95f8acd926a78fa285695c5242182c01055c54 Mon Sep 17 00:00:00 2001 From: Rafael Schouten Date: Mon, 30 Oct 2023 19:54:54 +0100 Subject: [PATCH] fix api reference docs images (#550) * fix api reference docs images * no strict warning in mkdocs --- docs/mkdocs.yml | 4 ++-- src/methods/aggregate.jl | 2 +- src/methods/classify.jl | 4 ++-- src/methods/crop_extend.jl | 6 +++--- src/methods/mask.jl | 12 ++++++------ src/methods/mosaic.jl | 8 ++++---- src/methods/rasterize.jl | 4 ++-- src/methods/trim.jl | 4 ++-- 8 files changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 6f614eb6c..b91120efa 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -60,7 +60,7 @@ repo_url: https://github.com/rafaqz/Rasters.jl repo_name: Rasters edit_uri: "" # No edit button, as some of our pages are in /docs and some in /examples via symlink, so it's impossible for them all to be accurate -strict: true # Don't allow warnings during the build process +strict: false # Don't allow warnings during the build process extra_javascript: # The below three make MathJax work, see https://squidfunk.github.io/mkdocs-material/reference/mathjax/ - _static/mathjax.js @@ -111,4 +111,4 @@ nav: - "Examples and Plotting" : "scripts/generated/basics/plotting.md" - "A basic species distribution modelling workflow" : "scripts/generated/basics/gbif_wflow.md" - "Examples with Makie" : "scripts/generated/basics/plot_makie.md" - - "API Reference" : "reference.md" \ No newline at end of file + - "API Reference" : "reference.md" diff --git a/src/methods/aggregate.jl b/src/methods/aggregate.jl index 490dbd787..ba7311bb8 100644 --- a/src/methods/aggregate.jl +++ b/src/methods/aggregate.jl @@ -47,7 +47,7 @@ savefig("docs/build/aggregate_example.png"); nothing ``` -![aggregate](/build/aggregate_example.png) +![aggregate](../build/aggregate_example.png) Note: currently it is faster to aggregate over memory-backed arrays. Use [`read`](@ref) on `src` before use where required. diff --git a/src/methods/classify.jl b/src/methods/classify.jl index 4c3146475..81c99fed0 100644 --- a/src/methods/classify.jl +++ b/src/methods/classify.jl @@ -43,7 +43,7 @@ savefig("docs/build/classify_example.png"); nothing # output ``` -![classify](/build/classify_example.png) +![classify](../build/classify_example.png) $EXPERIMENTAL """ @@ -135,7 +135,7 @@ savefig("docs/build/classify_bang_example.png"); nothing # output ``` -![classify!](/build/classify_bang_example.png) +![classify!](../build/classify_bang_example.png) $EXPERIMENTAL """ diff --git a/src/methods/crop_extend.jl b/src/methods/crop_extend.jl index b153c2a64..aaf46f0d6 100644 --- a/src/methods/crop_extend.jl +++ b/src/methods/crop_extend.jl @@ -39,7 +39,7 @@ nothing # output ``` -![new zealand evenness cropped](/build/nz_crop_example.png) +![new zealand evenness cropped](../build/nz_crop_example.png) Crop to a polygon: @@ -61,7 +61,7 @@ savefig("docs/build/argentina_crop_example.png"); nothing # output ``` -![argentina evenness cropped](/build/argentina_crop_example.png) +![argentina evenness cropped](../build/argentina_crop_example.png) $EXPERIMENTAL """ @@ -146,7 +146,7 @@ nothing # output ``` -![extend](/build/extend_example.png) +![extend](../build/extend_example.png) $EXPERIMENTAL """ diff --git a/src/methods/mask.jl b/src/methods/mask.jl index 25adf8787..e82ea408c 100644 --- a/src/methods/mask.jl +++ b/src/methods/mask.jl @@ -52,11 +52,11 @@ savefig(b, "docs/build/mask_example_after.png"); nothing ### Before `mask`: -![before mask](/build/mask_example_before.png) +![before mask](../build/mask_example_before.png) ### After `mask`: -![after mask](/build/mask_example_after.png) +![after mask](../build/mask_example_after.png) $EXPERIMENTAL """ @@ -143,11 +143,11 @@ savefig(b, "docs/build/mask_bang_example_after.png"); nothing ### Before `mask!`: -![before mask!](/build/mask_bang_example_before.png) +![before mask!](../build/mask_bang_example_before.png) ### After `mask!`: -![after mask!](/build/mask_bang_example_after.png) +![after mask!](../build/mask_bang_example_after.png) $EXPERIMENTAL """ @@ -239,7 +239,7 @@ savefig("docs/build/boolmask_example.png"); nothing # output ``` -![boolmask](/build/boolmask_example.png) +![boolmask](../build/boolmask_example.png) $EXPERIMENTAL """ @@ -317,7 +317,7 @@ savefig("docs/build/missingmask_example.png"); nothing # output ``` -![missingmask](/build/missingmask_example.png) +![missingmask](../build/missingmask_example.png) $EXPERIMENTAL """ diff --git a/src/methods/mosaic.jl b/src/methods/mosaic.jl index b7bdceee1..a3dd8e55e 100644 --- a/src/methods/mosaic.jl +++ b/src/methods/mosaic.jl @@ -51,13 +51,13 @@ nothing ### Individual continents -![arica](/build/mosaic_example_africa.png) +![arica](../build/mosaic_example_africa.png) -![aus](/build/mosaic_example_aus.png) +![aus](../build/mosaic_example_aus.png) ### Mosaic of continents -![mosaic](/build/mosaic_example_combined.png) +![mosaic](../build/mosaic_example_combined.png) $EXPERIMENTAL """ @@ -131,7 +131,7 @@ nothing ``` -![mosaic](/build/mosaic_bang_example.png) +![mosaic](../build/mosaic_bang_example.png) $EXPERIMENTAL """ diff --git a/src/methods/rasterize.jl b/src/methods/rasterize.jl index 207ae319c..592d68692 100644 --- a/src/methods/rasterize.jl +++ b/src/methods/rasterize.jl @@ -387,7 +387,7 @@ savefig("docs/build/china_rasterized.png"); nothing ``` -![rasterize](/build/china_rasterized.png) +![rasterize](../build/china_rasterized.png) $EXPERIMENTAL """ @@ -529,7 +529,7 @@ savefig("docs/build/indonesia_rasterized.png"); nothing ``` -![rasterize](/build/indonesia_rasterized.png) +![rasterize](../build/indonesia_rasterized.png) $EXPERIMENTAL """ diff --git a/src/methods/trim.jl b/src/methods/trim.jl index f34b8d699..e1db66b02 100644 --- a/src/methods/trim.jl +++ b/src/methods/trim.jl @@ -43,11 +43,11 @@ savefig(b, "docs/build/trim_example_after.png"); nothing ### Before `trim`: -![before trim](/build/trim_example_before.png) +![before trim](../build/trim_example_before.png) ### After `trim`: -![after trim](/build/trim_example_after.png) +![after trim](../build/trim_example_after.png) $EXPERIMENTAL """