jk/documenter master (#663)

.github/workflows/docs.yml

@@ -40,7 +40,7 @@ jobs:
       - name: Install binary dependencies
         run: sudo apt-get update && sudo apt-get install -y xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev
       - name: Install Julia dependencies
-        run: DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+        run: DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.add(url = "https://github.com/JuliaDocs/Documenter.jl", rev = "master"); Pkg.instantiate()'
       - name: Build and deploy
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -11,5 +11,6 @@ bluemarble-2048.png
 phases.0001_print.jpg
 **/._*
 Manifest.toml
+!docs/Manifest.toml
 
 \.DS_Store

docs/.gitignore

@@ -17,7 +17,7 @@ src/generated
 *.zip
 tmax
 prec
-Manifest.toml
+#Manifest.toml
 
 src/assets/syntaxtheme.css
 

docs/src/faq.md

@@ -113,11 +113,9 @@ ax2 = layout[1, 1] = Axis(scene, title = "Placed in Layout")
 ax3 = Axis(scene, bbox = BBox(400, 800, 400, 800),
   title = "Placed at BBox(400, 800, 400, 800)")
 
-save("faq_squashed_element.svg", scene); nothing # hide
+scene
 ```
 
-![squashed elements](faq_squashed_element.svg)
-
 
 ### Columns or rows are shrunk to the size of Text or another element
 
@@ -141,11 +139,9 @@ layout[2, 1] = Axis(scene, title = "Expanded")
 layout[1, 2] = Label(scene, "tellheight = true", tellheight = true)
 layout[2, 2] = Label(scene, "tellheight = false", tellheight = false)
 
-save("faq_shrunk_row.svg", scene); nothing # hide
+scene
 ```
 
-![shrunk row](faq_shrunk_row.svg)
-
 ```@eval
 using GLMakie
 GLMakie.activate!()

docs/src/figure.md

@@ -70,10 +70,8 @@ lines(pos2, cumsum(randn(100)))
 heatmap(f[1, 3], randn(10, 10))
 
 f
-save("figurepositions.svg", f); nothing # hide
 ```
 
-![figurepositions](figurepositions.svg)
 
 You can also index further into a `FigurePosition`, which creates a `FigureSubposition`.
 With `FigureSubposition`s you can describe positions in arbitrarily nested grid layouts.
@@ -92,10 +90,8 @@ f[1, 2][1, 1] = Axis(f, title = "I'm nested")
 heatmap(f[1, 2][2, 1], randn(20, 20))
 
 f
-save("figurepositions_2.svg", f); nothing # hide
 ```
 
-![figurepositions_2](figurepositions_2.svg)
 
 All nested grid layouts that don't exist yet, but are needed for a nested plotting call, are created in the background automatically.
 

docs/src/makielayout/axis.md

@@ -18,11 +18,9 @@ scene, layout = layoutscene(resolution = (1200, 900))
 ax = layout[1, 1] = Axis(scene, xlabel = "x label", ylabel = "y label",
     title = "Title")
 
-save("basic_axis.svg", scene) # hide
-nothing # hide
+scene
 ```
 
-![basic axis](basic_axis.svg)
 
 ## Plotting Into an Axis
 
@@ -35,8 +33,7 @@ that it is more convenient to save and manipulate the plot objects.
 ```@example laxis
 lineobject = lines!(ax, 0..10, sin, color = :red)
 
-save("basic_axis_plotting.svg", scene) # hide
-nothing # hide
+scene
 ```
 
 ![basic axis plotting](basic_axis_plotting.svg)
@@ -74,8 +71,7 @@ ylims!(axes[4], (1, -1)) # as tuple, reversed
 limits!(axes[5], 0, 2pi, -1, 1) # x1, x2, y1, y2
 limits!(axes[6], BBox(0, 2pi, -1, 1)) # as rectangle
 
-save("example_axis_limits.svg", scene) # hide
-nothing # hide
+scene
 ```
 
 ![axis limits](example_axis_limits.svg)
@@ -157,12 +153,9 @@ axes[4].xtickformat = "{:.2f}ms"
 axes[4].xlabel = "Time"
 
 
-save("example_axis_ticks.svg", scene) # hide
-nothing # hide
+scene
 ```
 
-![axis ticks](example_axis_ticks.svg)
-
 ## Minor Ticks and Grids
 
 You can show minor ticks and grids by setting `x/yminorticksvisible = true` and `x/yminorgridvisible = true` which are off by default.
@@ -192,11 +185,9 @@ fig = with_theme(theme) do
         yminorticks = IntervalsBetween(n+1)) for n in 1:4]
     fig
 end
-save("example_minor_ticks.svg", fig) # hide
-nothing # hide
-```
 
-![minor ticks](example_minor_ticks.svg)
+fig
+```
 
 
 ## Hiding Axis Spines and Decorations
@@ -217,11 +208,9 @@ ax2 = layout[1, 2] = Axis(scene, title = "Axis 2")
 hidespines!(ax1)
 hidespines!(ax2, :t, :r) # only top and right
 
-save("example_axis_hidespines.svg", scene) # hide
-nothing # hide
+scene
 ```
 
-![axis hide spines](example_axis_hidespines.svg)
 
 To hide decorations, you can use `hidedecorations!`, or the specific `hidexdecorations!` and `hideydecorations!`.
 When hiding, you can set `label = false`, `ticklabels = false`, `ticks = false`, `grid = false`, `minorgrid = false` or `minorticks = false` as keyword
@@ -277,12 +266,9 @@ axes[2, 2].aspect = AxisAspect(2)
 axes[2, 3].title = "AxisAspect(0.5)"
 axes[2, 3].aspect = AxisAspect(0.5)
 
-save("example_axis_aspects.svg", scene) # hide
-nothing # hide
+scene
 ```
 
-![axis aspects](example_axis_aspects.svg)
-
 
 ## Controlling Data Aspect Ratios
 
@@ -386,12 +372,9 @@ for i in 1:3
     end
 end
 
-save("example_linked_axes.svg", scene) # hide
-nothing # hide
+scene
 ```
 
-![linked axes](example_linked_axes.svg)
-
 
 ## Axis interaction
 
@@ -526,10 +509,8 @@ ax2 = layout[1, 2] = Axis(scene, title = "hlines")
 hlines!(ax2, [1, 2, 3, 4], xmax = [0.25, 0.5, 0.75, 1], color = :blue)
 
 scene
-save("example_vlines.svg", scene); nothing # hide
 ```
 
-![example vlines](example_vlines.svg)
 
 ```@eval
 using GLMakie

docs/src/makielayout/box.md

@@ -18,7 +18,6 @@ rects = fig[1:4, 1:6] = [
     Box(fig, color = c)
     for c in get.(Ref(ColorSchemes.rainbow), (0:23) ./ 23)]
 
-save("example_lrect.svg", fig); nothing # hide
+fig
 ```
 
-![example lrect](example_lrect.svg)

docs/src/makielayout/button.md

@@ -22,8 +22,4 @@ for button in buttons
 end
 
 fig
-
-save("example_lbutton.svg", fig); nothing # hide
 ```
-
-![example lbutton](example_lbutton.svg)

docs/src/makielayout/colorbar.md

@@ -36,12 +36,8 @@ Colorbar(fig[4, 1], height = 25, limits = (-1, 1), colormap = :heat,
     highclip = :cyan, lowclip = :red)
 
 fig
-
-save("example_colorbar.svg", fig); nothing # hide
 ```
 
-![example colorbar](example_colorbar.svg)
-
 You can also automatically choose colormap and limits for certain plot objects by passing them as the second argument.
 
 ```@example
@@ -69,8 +65,5 @@ ax, hm = contourf(fig[2, 2][1, 1], xs, ys, zs,
 Colorbar(fig[2, 2][1, 2], hm, width = 20, ticks = -1:0.25:1)
 
 fig
-save("example_colorbar_2.svg", fig); nothing # hide
 ```
 
-![example colorbar 2](example_colorbar_2.svg)
-

docs/src/makielayout/gridlayout.md

@@ -26,12 +26,8 @@ colsize!(layout, 1, Fixed(400))
 # colsize!(layout, 1, 400) would also work
 
 scene
-save("example_fixed_size.svg", scene); nothing # hide
 ```
 
-![fixed size](example_fixed_size.svg)
-
-
 ### Relative
 
 `Relative(fraction)` is used to set a column or row to a size that is a certain fraction of the available width or height.
@@ -50,11 +46,8 @@ layout[1, 3] = Colorbar(scene, width = 30)
 colsize!(layout, 1, Relative(2/3))
 
 scene
-save("example_relative_size.svg", scene); nothing # hide
 ```
 
-![relative size](example_relative_size.svg)
-
 
 ### Auto
 
@@ -92,11 +85,8 @@ colsize!(layout, 2, Auto(1)) # equivalent to Auto(true, 1)
 colsize!(layout, 3, Auto(2)) # equivalent to Auto(true, 2)
 
 scene
-save("example_auto_size.svg", scene); nothing # hide
 ```
 
-![auto size](example_auto_size.svg)
-
 
 ### Aspect
 
@@ -120,11 +110,8 @@ rowsize!(layout, 2, Relative(2/3))
 colsize!(layout, 1, Aspect(1, 1))
 
 scene
-save("example_aspect_size.svg", scene); nothing # hide
 ```
 
-![aspect size](example_aspect_size.svg)
-
 !!! note
 
     Keep in mind that if you set too many constraints on row and column sizes, a GridLayout can easily be too big or too small. It's good to have variable-width elements to fill the remaining space if you use an element with fixed size or fixed aspect ratio.
@@ -152,11 +139,9 @@ subgl_right[1:3, 1] = [Axis(scene) for i in 1:3]
 layout[1, 1] = subgl_left
 layout[1, 2] = subgl_right
 
-save("example_nested_grids.svg", scene); nothing # hide
+scene
 ```
 
-![example nested grids](example_nested_grids.svg)
-
 ## Alignment
 
 Here you can see the difference between the align modes Outside with and without
@@ -185,10 +170,9 @@ subgl_3[1, 1] = Axis(scene, title="Outside(50)")
 
 layout[1:3, 2] = [Box(scene, color = :transparent, strokecolor = :red) for i in 1:3]
 
-save("example_grid_alignment.svg", scene); nothing # hide
+scene
 ```
 
-![example grid alignment](example_grid_alignment.svg)
 
 ## Spanned Placement
 
@@ -207,11 +191,9 @@ layout[:, 3] = Axis(scene, title="[:, 3]")
 layout[1:3, end] = Axis(scene, title="[1:3, end]")
 layout[end, end] = Axis(scene, title="[end, end]")
 
-save("example_spanned_grid_content.svg", scene); nothing # hide
+scene
 ```
 
-![spanned grid content](example_spanned_grid_content.svg)
-
 ## Adding rows and columns by indexing
 
 If you index outside of the current range of a grid layout, you do not get an
@@ -237,11 +219,9 @@ layout[2:end-1, 0] = Label(scene, text="Left Text", textsize=50,
 layout[2:end-1, end+1] = Label(scene, text="Right Text", textsize=50,
     rotation=-pi/2)
 
-save("example_indexing_outside_grid.svg", scene); nothing # hide
+scene
 ```
 
-![indexing outside grid](example_indexing_outside_grid.svg)
-
 
 ## Trimming empty rows and columns
 
@@ -259,34 +239,25 @@ ax1 = layout[1, 1] = Axis(scene, title = "Axis 1")
 ax2 = layout[1, 2] = Axis(scene, title = "Axis 2")
 
 scene
-save("example_trimming_1.svg", scene); nothing # hide
 ```
 
-![trimming 1](example_trimming_1.svg)
-
 Now we decide we'd like the second axis better if it was below the first one.
 We move it two the new cell, and the old unused column is left blank.
 
 ```@example trimming
 layout[2, 1] = ax2
 
 scene
-save("example_trimming_2.svg", scene); nothing # hide
 ```
 
-![trimming 2](example_trimming_2.svg)
-
 We can get rid of the unused space with `trim!`:
 
 ```@example trimming
 trim!(layout)
 
 scene
-save("example_trimming_3.svg", scene); nothing # hide
 ```
 
-![trimming 3](example_trimming_3.svg)
-
 
 ## Tweaking space between rows and columns
 
@@ -308,22 +279,16 @@ hidedecorations!.(axs, grid=false)
 colgap!(fig.layout, 1, Relative(0.15))
 
 fig
-save("example_spacing_1.svg", fig); nothing # hide
 ```
 
-![spacing 1](example_spacing_1.svg)
-
 All spaces can be changed at once by omitting the index of the gap to resize.
 
 ```@example spacing
 rowgap!(fig.layout, 50)
 
 fig
-save("example_spacing_2.svg", fig); nothing # hide
 ```
 
-![spacing 2](example_spacing_2.svg)
-
 
 ```@eval
 using GLMakie

docs/src/makielayout/label.md

@@ -19,8 +19,5 @@ supertitle = Label(fig[0, :], "Six plots", textsize = 30)
 
 sideinfo = Label(fig[2:3, 0], "This text is vertical", rotation = pi/2)
 
-save("example_ltext.svg", fig); nothing # hide
+fig
 ```
-
-![example ltext](example_ltext.svg)
-