From e2de6d458901d0e7b7aa41cbc199e7bc52d6fa98 Mon Sep 17 00:00:00 2001 From: Simon Christ Date: Tue, 9 Jul 2024 16:03:00 +0200 Subject: [PATCH] start section about plot objects --- docs/Project.toml | 1 - docs/gallery/inspectdr/index.md | 5 ++++- docs/make.jl | 6 +++--- docs/src/backends.md | 4 ---- docs/src/plot_objects.md | 11 +++++++++++ 5 files changed, 18 insertions(+), 9 deletions(-) create mode 100644 docs/src/plot_objects.md diff --git a/docs/Project.toml b/docs/Project.toml index add45e3434..d1d8c8f056 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -15,7 +15,6 @@ Graphs = "86223c79-3864-5bf0-83f7-82e725a168b6" ImageIO = "82e4d734-157c-48bb-816b-45c225c6df19" ImageMagick = "6218d12a-5da1-5696-b52f-db25d2ecc6d1" Images = "916415d5-f1e6-5110-898d-aaa5f9f070e0" -InspectDR = "d0351b0e-4b05-5898-87b3-e2a8edfddd1d" JSON = "682c06a0-de6a-54ab-a142-c8b1cf79cde6" LaTeXStrings = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f" LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e" diff --git a/docs/gallery/inspectdr/index.md b/docs/gallery/inspectdr/index.md index 7bca29e769..dce74ce838 100644 --- a/docs/gallery/inspectdr/index.md +++ b/docs/gallery/inspectdr/index.md @@ -1,10 +1,13 @@ # InspectDR +!!! warn + `InspectDR` currently does not precompile on julia 1.10+. + To switch to the `InspectDR` backend, you can use: ```julia using Plots -inspectdr() +# inspectdr() ``` The demos are generated from `Plots._examples`. Empty demos are features that this backend does not support. diff --git a/docs/make.jl b/docs/make.jl index 7e14a5615e..22099c75a5 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -578,10 +578,10 @@ function main() pgfplotsx() unicodeplots() gaston() - inspectdr() + # inspectdr() # NOTE: for a faster representative test build use `PLOTDOCS_BACKENDS='GR' PLOTDOCS_EXAMPLES='1'` - default_backends = "GR PythonPlot PlotlyJS PGFPlotsX UnicodePlots Gaston InspectDR" + default_backends = "GR PythonPlot PlotlyJS PGFPlotsX UnicodePlots Gaston" backends = get(ENV, "PLOTDOCS_BACKENDS", default_backends) backends = backends == "ALL" ? default_backends : backends @info "selected backends: $backends" @@ -680,7 +680,7 @@ function main() ], "Overview" => "ecosystem.md", ], - "Advanced Topics" => ["Internals" => "pipeline.md"], + "Advanced Topics" => ["Plot objects" => "plot_objects.md","Plotting pipeline" => "pipeline.md"], "Gallery" => gallery, "User Gallery" => user_gallery, "API" => "api.md", diff --git a/docs/src/backends.md b/docs/src/backends.md index 9c8e88d8ed..5be18c97b2 100644 --- a/docs/src/backends.md +++ b/docs/src/backends.md @@ -384,10 +384,6 @@ gaston(); backendplot() #hide Fast plotting with a responsive GUI (optional). Target: quickly identify design/simulation issues & glitches in order to shorten design iterations. -```@example backends -inspectdr(); backendplot(n = 2) #hide -``` - Pros: - Relatively short load times / time to first plot. diff --git a/docs/src/plot_objects.md b/docs/src/plot_objects.md new file mode 100644 index 0000000000..5e10a62928 --- /dev/null +++ b/docs/src/plot_objects.md @@ -0,0 +1,11 @@ +# [Plot objects](@id object) + +The [`plot`](@ref) function returns a bespoke julia type called [`Plot`](@ref). +The plot object. +It holds all the attributes of the plot itself its [`Subplot`](@ref)s and [`Series`](@ref). + +```@docs +Plot +Subplot +Series +``` \ No newline at end of file