Skip to content

Commit

Permalink
update docs, changelog, add contributing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
j-fu committed Nov 25, 2024
1 parent 18e5ae3 commit 95ead5a
Show file tree
Hide file tree
Showing 4 changed files with 132 additions and 137 deletions.
6 changes: 5 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
# Changelog

## [unreleased]
## [1.9.0] - 2024-11-25

### Added

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

### Fixed

- removed dependency on type piracy of Colors.RGB

## [1.8.2] - 2024-11-08

### Fixed
Expand Down
3 changes: 2 additions & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,9 @@ function mkdocs()
pages = [
"Home" => "index.md",
"Public API" => "api.md",
"Private API" => "privapi.md",
"Examples" => generated_examples,
"Private API" => "privapi.md",
"Contributing" => "contributing.md",
]
)
end
Expand Down
26 changes: 26 additions & 0 deletions docs/src/contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
## Hints for contributors
Non-experimental backends are: Makie, PyPlot, PlutoVista, partially Plots. These should be checked before
submitting a pull request.

As it is not easy to install a decent CI for graphical interfaces, visual checking can be performed in the following way.
Create an environment which contains ExtendableGrids, GLMakie, PyPlot, PlutoVista, Plots and PlutoUI, and develops GridVisualize.
A good option is to create a "shared environment" `@GridVisualize` (assuming GridVisualize is worked on in `JULIA_PKG_DEVDIR`):
```
$ julia --project=@GridVisualize
$ julia> ] # Enter Pkg mode
$ (@GridVisualize) pkg> add GLMakie, PyPlot, PlutoVista, Plots, PlutoUI, ExtendableGrids
$ (@GridVisualize) pkg> dev GridVisualize
$ julia> using GridVisualize GLMakie, PyPlot, Plots
$ julia> include("examples/plotting.jl")
$ julia> plotting_multiscene(Plotter=PyPlot)
$ julia> plotting_multiscene(Plotter=Plots)
$ julia> plotting_multiscene(Plotter=GLMakie)
```
For checking the PlutoVista backend, perform in the same environment
```
julia> using Pluto
julia> ENV["PLUTO_PROJECT"]=Base.active_project()
julia> Pluto.run(notebook="examples/plutovista.jl")
```

Loading

0 comments on commit 95ead5a

Please sign in to comment.