Move to mkdocs (or equivalent) for docs

[brynpickering]

The project uses Sphinx & ReST for docs. This requires context switching from other docs in the pypsa org, which are increasingly built with mkdocs and written in markdown.

We might not want to go to mkdocs due to the repeated warnings about plugins breaking from v2. Perhaps to Zensical or properdocs?

[FBumann]

@brynpickering I discussed this with fabian a few weeks ago and we decided to stay on sphinx for now.
Reasons are that our docs are mostly notebooks, and those render quite well on sphinx.

Im open on rediscussing this if you think its needed. I agree that writing markdown is far superior!

Id say this is a post v1 task

[brynpickering]

@FBumann - interesting! notebook rendering also works fine with mkdocs - perhaps better since you can point directly to them as pages rather than needing the .nblink pages that are currently used. I agree though that this is low prio.

[FBumann]

@brynpickering Yes, t works, but I prefer the looks of sphynx. You can cofigure mkdocs, but I worked a bit on it and was never really satisfied compared to linopys version

See: https://flixopt.github.io/flixopt/latest/notebooks/02-heat-system/

But Its only a matter of putting some time in I think.