Skip to content

Commit 95ead5a

Browse files
committed
update docs, changelog, add contributing.md
1 parent 18e5ae3 commit 95ead5a

File tree

4 files changed

+132
-137
lines changed

4 files changed

+132
-137
lines changed

CHANGELOG.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# Changelog
22

3-
## [unreleased]
3+
## [1.9.0] - 2024-11-25
44

55
### Added
66

77
- new key word argument `show_colorbar` (default=true) to toggle the color bar next to grid plots
88

9+
### Fixed
10+
11+
- removed dependency on type piracy of Colors.RGB
12+
913
## [1.8.2] - 2024-11-08
1014

1115
### Fixed

docs/make.jl

+2-1
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,9 @@ function mkdocs()
4040
pages = [
4141
"Home" => "index.md",
4242
"Public API" => "api.md",
43-
"Private API" => "privapi.md",
4443
"Examples" => generated_examples,
44+
"Private API" => "privapi.md",
45+
"Contributing" => "contributing.md",
4546
]
4647
)
4748
end

docs/src/contributing.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## Hints for contributors
2+
Non-experimental backends are: Makie, PyPlot, PlutoVista, partially Plots. These should be checked before
3+
submitting a pull request.
4+
5+
As it is not easy to install a decent CI for graphical interfaces, visual checking can be performed in the following way.
6+
Create an environment which contains ExtendableGrids, GLMakie, PyPlot, PlutoVista, Plots and PlutoUI, and develops GridVisualize.
7+
A good option is to create a "shared environment" `@GridVisualize` (assuming GridVisualize is worked on in `JULIA_PKG_DEVDIR`):
8+
```
9+
$ julia --project=@GridVisualize
10+
$ julia> ] # Enter Pkg mode
11+
$ (@GridVisualize) pkg> add GLMakie, PyPlot, PlutoVista, Plots, PlutoUI, ExtendableGrids
12+
$ (@GridVisualize) pkg> dev GridVisualize
13+
$ julia> using GridVisualize GLMakie, PyPlot, Plots
14+
$ julia> include("examples/plotting.jl")
15+
$ julia> plotting_multiscene(Plotter=PyPlot)
16+
$ julia> plotting_multiscene(Plotter=Plots)
17+
$ julia> plotting_multiscene(Plotter=GLMakie)
18+
```
19+
For checking the PlutoVista backend, perform in the same environment
20+
```
21+
julia> using Pluto
22+
julia> ENV["PLUTO_PROJECT"]=Base.active_project()
23+
julia> Pluto.run(notebook="examples/plutovista.jl")
24+
25+
```
26+

0 commit comments

Comments
 (0)