Build documentation with mkdocs

[DavUhll]

Proposal for documentation with mkdos.

This PR is shows how to use mkdocs to create static documentation which can be later used in CI and host on GitHub pages.

There a quiet some changes in the folder structure, since all the README.md are now located in the docs folder.
Maybe not every link is updated correctly.

How to build docs locally:
pip install -r docs/requirements.txt
mkdocs serve

[DavUhll]

Let's start fancy stuff with mkdocs @m-naumann 😄

[m-naumann]

Awesome 🚀 Thanks!

Would you mind adding a CI pipeline for that in your fork, such that we could have a look at the outcome more easily? 😃

Should be just a few lines, I did that here for example. Also, in case people do not like the moving and we don't have too much trouble with links, we could copy the stuff into docs in CI only, as I did there for some stuff.

[DavUhll]

Awesome 🚀 Thanks!

Would you mind adding a CI pipeline for that in your fork, such that we could have a look at the outcome more easily? 😃

Should be just a few lines, I did that here for example. Also, in case people do not like the moving and we don't have too much trouble with links, we could copy the stuff into docs in CI only, as I did there for some stuff.

Makes sense. I will check if this is also possible here 👍

[m-naumann]

@DavUhll I added deployment and deployed to https://m-naumann.github.io/Lanelet2-1/, you can merge https://github.com/m-naumann/Lanelet2-1/tree/master into your branch for this update.

Looks nice at the first glance, however some links are broken (hard to fix since they either match the repo or the deployed docs, I guess), and the edit function is broken due to copying the files. But maybe we can go with this for the start. WDYT @immel-f @poggenhans?

[immel-f]

Looks very nice, thanks 👍
I browsed a bit through the deployed version and only found links that point to the repo instead of the website. If that is the only problem, I think we can go with this for now since it is already a big improvement to the existing docs interface

[DavUhll]

@DavUhll I added deployment and deployed to https://m-naumann.github.io/Lanelet2-1/, you can merge https://github.com/m-naumann/Lanelet2-1/tree/master into your branch for this update.

Looks nice at the first glance, however some links are broken (hard to fix since they either match the repo or the deployed docs, I guess), and the edit function is broken due to copying the files. But maybe we can go with this for the start. WDYT @immel-f @poggenhans?

@m-naumann Thanks for the commit. I've added your commit to this PR.
@immel-f if you agree, I would open this PR and then open a follow up PR to fix all the links to link to the documentation.

let me know what you think about it.

[immel-f]

@DavUhll I added deployment and deployed to https://m-naumann.github.io/Lanelet2-1/, you can merge https://github.com/m-naumann/Lanelet2-1/tree/master into your branch for this update.
Looks nice at the first glance, however some links are broken (hard to fix since they either match the repo or the deployed docs, I guess), and the edit function is broken due to copying the files. But maybe we can go with this for the start. WDYT @immel-f @poggenhans?

@m-naumann Thanks for the commit. I've added your commit to this PR. @immel-f if you agree, I would open this PR and then open a follow up PR to fix all the links to link to the documentation.

let me know what you think about it.

Sounds great, I am not sure however what to do to fix the links since as I understood it, either the doc or repo links will be broken 😅

What url will the docs be deployed to? We should probably also add a link to the readme before merging.

[immel-f]

Is this PR ready for merging? I think it would make a very nice addition. If you know to which URL the docs will be deployed to it would be helpful to add a link to the readme as well.

[DavUhll]

Is this PR ready for merging? I think it would make a very nice addition. If you know to which URL the docs will be deployed to it would be helpful to add a link to the readme as well.

I've updated the README.md.

[m-naumann]

Looks good to me now: https://m-naumann.github.io/Lanelet2-1/

[m-naumann]

pinging again 😉

[immel-f]

Thanks for the reminder 😅