First draft commit of GridVisualize-Doc with Examplejuggler

[Liameloy]

Request to review the documentation created with ExampleJuggler.jl integrated into the process.
Multiple files were no longer necessary, therefore have been removed (though still existing on my machine in a separate folder, should they be necessary).
I mostly used the make.jl of SimplexGridFactory.jl as a kind of template and then added/changed things to make the documentation buildable and make it look as close to the original documentation as possible.

Following things have been done to achieve this and with the goal of reducing "file-clutter" (e.g. needing to add the same functions to multiple files) in mind:
Changed make.jl to use the macros @docscripts/@docplutonotebooks
Added a generateplots-function to plotting.jl since @docscripts-macro requires this, effectively combining plotting.jl and makeplots.jl and using the contents of makeplots.jl for generateplots.
Due to this makeplots.jl and makefigs.jl were no longer necessary, so i removed them from my local GridVisualize-Project.
In the first run of trying to build this doc, multiple times errors like "Package xyz missing, run 'using Pkg; add Pkg("xyz")'" turned up, so I added them.

[Liameloy]

I can already see that the code quality check has failed, I may have forgot to run runic before pushing.

[pjaap]

Yes, please make sure that code quality passes. However, the failing unit tests are caused by a (probably unrelated) Python error in the runner. We had this before in another PR in this repo. I'll take a closer look there

[Liameloy]

Reviewing the code quality check result yields clarity. I misspelled "successfully".

[pjaap]

Please use pre-commit in your machine to get automatic fixes of the code quality issues.

[pjaap]

Great. I think you get meaningful error messages now form the CI. There are some files included that do not exist any more.

[pjaap]

Thanks for the rework.

However, some parts are not clear to me, which is not that bad.

Please write a small recap (list) of what you did in the first comment of this PR (edit the comment). Then we can approve the changes.

[j-fu]

Hi, thanks for the initiative, and for the work so far !

• I wonder, why the new additions in Project.toml are needed.
• Also I suggest to keep pyplot out of the game for the docs (besides testing) and to focus on CairoMakie - just in order to prevent annoying hiccups with the python installation.

[Liameloy]

In regards to the added Packages:
PyPlot has been removed. As I used the make.jl from SimplexGridFactory.jl, which has plots in PyPlot as well, as a pseudo-template, I initially added PyPlot to see what would work.

PlutoSliderServer is necessary for the @docplutonotebook-macro. If it is not imported in the make.jl it yields this error:
'LoadError: Please import/use PlutoSliderServer.jl in order to use docplutonotebooks with iframe=true'

The adding of ExampleJuggler is selfexplanatory i reckon.

[j-fu]

Yes, but they are needed just in docs/Project.toml, but not in the Project.toml of the package.
When running documentation generation, one just needs to work in the docs environment, not in the package environment, like

julia --project=docs docs/make.toml

I tried to write about environments, package workflow etc. here. Please let me know if something is missing there.

[Liameloy]

Ah, that clears things up. I was aware that the docs was a project on its own, but I did not know that the "parent"-Package of the docs-Package did not need to include the same packages.

I was thinking in ways of some inheritance structure for some reason.

It will be (has been) adjusted and will be included in the next push.

[Liameloy]

squashed and ready