Adding Docs Workflow

[gordonkoehn]

This PR implements a workflow to automatically generate documentation using mkdocs in this repository. The workflow was copied from https://github.com/cbg-ethz/bmi

@pawel-czyz This is my first progress on the documentation. I think I understand how to use mkdocs and quarto now. I shamelessly plagiarised the README soft link trick and contributing page from your BMI repo. I hope that's ok! :)

So far I have managed to

• get the API generated,
• added a contributing page
• put the READ.md as a placeholder (needs updating)
• I added my first small tutorial on how to run a single SCITE MCMC with the functions themselves (I am aiming to add more on workflows, distances and analytics)

I tested it all with poetry mkdocs serve, but I understand that the deployment on github pages is not something I can test and will happen automatically with the github workflow that I copied from BMI.

What do you think? Shall we try a first deployment as this - I'll update with more content later this week.

[pawel-czyz]

Great work! As you mentioned, we need to let GitHub build the documentation and then we can see whether everything works.
(Usually once I know that the workflow works properly, I use mkdocs locally to fix the issues.)

Would you mind merging?