HELP WANTED | Let's switch to Markdown & mkdocs - from restructuredText & Sphinx

[funilrys]

As mentioned in #340, it's time to move away from restructured text.

This PR is a work in progress. - feel free to contribute!

[coveralls]

coverage: 94.723%. remained the same when pulling 4c20487134e8f45560b31980f59b60ee4ebd0fdc on switch-to-mkdocs into f848dc95df1b5405442d63ecbcfd5feb2ba90533 on dev.

[spirillen]

You should make sure`material.extensions' gets installed... (https://github.com/funilrys/PyFunceble/issues/340#issuecomment-1863938452)

[funilrys]

After each push into the switch-to-mkdocs branch, a new documentation will be published to https://hub.docker.com/r/pyfunceble/docs and later automatically fetched and readable from https://docs.pyfunceble.com.

cc: @mitchellkrogza @spirillen

[spirillen]

After each push into the switch-to-mkdocs branch, a new documentation will be published to https://hub.docker.com/r/pyfunceble/docs and later automatically fetched and readable from https://docs.pyfunceble.com.

cc: @mitchellkrogza @spirillen

I have made a fork and moved to https://github.com/foreign-affairs/PyFunceble-docs this repo will de docs only, and the default branch are changed to switch-to-mkdocs so for ease, would it be possible we made changes there, and then pushed here?

[spirillen]

What is destination folder and what is the old docs?

I assume https://github.com/funilrys/PyFunceble/tree/switch-to-mkdocs/docs is the new target while https://github.com/funilrys/PyFunceble/tree/switch-to-mkdocs/sphinx-docs should be considered as the source. right?