Migrate docs to mkdocs

[euronion]

I was wasting time with SPHINX and considered it to be faster to migrate to mkdocs.

I tried to migrate as much as closely as possible, but I introduced some changes to be a bit more consistent and foreward looking towards a harmonised doc structure with pypsa v1 docs.

Checklist

• Code changes are sufficiently documented; i.e. new functions contain docstrings and further explanations may be given in doc.
• [n/a] Unit tests for new features were added (if applicable).
• A note for the release notes doc/release_notes.rst of the upcoming release is included.
• I consent to the release of this PR's code under the MIT license.

[lkstrp]

Lovely, go for it

I just setup readthedocs builds for PRs so we can get a preview. Hope this just needs another commit to be triggered

[euronion]

Yep, that tricked the did.

[euronion]

Voila: https://powerplantmatching--253.org.readthedocs.build/en/253/

[lkstrp]

Out of the box so much better!

One thing is now that we lost all git file history when renaming to .md. That's not a big deal, but it would be nicer to keep them, because with two mkdocs plugins, the contributors and when a page was created and last edited are displayed. We have that in the PyPSA Docs as well.

Basically, it just needs a rename commit at the beginning (instead of 5287890). But I can also fix that before we merge with some git magic, so that's fine

[euronion]

Basically, it just needs a rename commit at the beginning (instead of 5287890). But I can also fix that before we merge with some git magic, so that's fine

I'll let you do the magic under the condition that you teach me (the) magic.

[euronion]

TODO post merge of #254 :

• Make sure that the License information on doc landing page is correct
• Link to doc/contributors.md in README.md

[fneum]

Excellent!

[euronion]

Out of the box so much better!

One thing is now that we lost all git file history when renaming to .md. That's not a big deal, but it would be nicer to keep them, because with two mkdocs plugins, the contributors and when a page was created and last edited are displayed. We have that in the PyPSA Docs as well.

Basically, it just needs a rename commit at the beginning (instead of 5287890). But I can also fix that before we merge with some git magic, so that's fine

Sorry @lkstrp , I over eargerly merged and forgot about your comment.
I'll revert so you can do you magic once you have the time!