Skip to content

Commit

Permalink
Figure size and dpi how-to (#4504)
Browse files Browse the repository at this point in the history
* add typst to doc deps

* Rewrite figure size implementations and add simplified how-to

* remove unnecessary mkpath

* fix links
  • Loading branch information
jkrumbiegel authored Oct 21, 2024
1 parent aa889ab commit 981d954
Show file tree
Hide file tree
Showing 5 changed files with 174 additions and 50 deletions.
1 change: 1 addition & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,5 @@ NodeJS = "2bd173c7-0d6d-553b-b6af-13a54713934c"
Observables = "510215fc-4207-5dde-b226-833fc4488ee2"
RPRMakie = "22d9f318-5e34-4b44-b769-6e3734a732a6"
RadeonProRender = "27029320-176d-4a42-b57d-56729d2ad457"
Typst_jll = "eb4b1da6-20f6-5c66-9826-fdb8ad410d0e"
WGLMakie = "276b4fcb-3e11-5398-bf8b-a0c2d153d008"
43 changes: 24 additions & 19 deletions docs/makedocs.jl
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ pages = [
"explanations/transparency.md",
],
"How-Tos" => [
"how-to/match-figure-size-font-sizes-and-dpi.md",
"how-to/draw-boxes-around-subfigures.md",
"how-to/save-figure-with-transparency.md",
],
Expand All @@ -197,25 +198,29 @@ pages = [
]
]

empty!(MakieDocsHelpers.FIGURES)

# filter pages here when working on docs interactively
# pages = nested_filter(pages, r"reference/blocks/(axis|axis3|overview)")

Documenter.makedocs(;
sitename="Makie",
format=DocumenterVitepress.MarkdownVitepress(;
repo = "github.com/MakieOrg/Makie.jl",
devurl = "dev",
devbranch = "master",
deploy_url = "https://docs.makie.org", # for local testing not setting this has broken links with Makie.jl in them
description = "Create impressive data visualizations with Makie, the plotting ecosystem for the Julia language. Build aesthetic plots with beautiful customizable themes, control every last detail of publication quality vector graphics, assemble complex layouts and quickly prototype interactive applications to explore your data live.",
deploy_decision,
),
pages,
expandfirst = unnest(nested_filter(pages, r"reference/(plots|blocks)/(?!overview)")),
warnonly = get(ENV, "CI", "false") != "true",
pagesonly = true,
function make_docs(; pages)
empty!(MakieDocsHelpers.FIGURES)

Documenter.makedocs(;
sitename="Makie",
format=DocumenterVitepress.MarkdownVitepress(;
repo = "github.com/MakieOrg/Makie.jl",
devurl = "dev",
devbranch = "master",
deploy_url = "https://docs.makie.org", # for local testing not setting this has broken links with Makie.jl in them
description = "Create impressive data visualizations with Makie, the plotting ecosystem for the Julia language. Build aesthetic plots with beautiful customizable themes, control every last detail of publication quality vector graphics, assemble complex layouts and quickly prototype interactive applications to explore your data live.",
deploy_decision,
),
pages,
expandfirst = unnest(nested_filter(pages, r"reference/(plots|blocks)/(?!overview)")),
warnonly = get(ENV, "CI", "false") != "true",
pagesonly = true,
)
end

make_docs(;
# filter pages here when working on docs interactively
pages # = nested_filter(pages, r"explanations/figure|match-figure"),
)

##
Expand Down
Loading

0 comments on commit 981d954

Please sign in to comment.