creating a doc page with autodocs and everything

[helpmefindaname]

Building a doc page to contain more than just the tutorials.

• ci-cd setup for multiple versions
• extended contributor guide
• versioning working with "latest" (main) and "stable" (latest released version)
• autodocs for selected packages/modules
• ensure that the module structure makes sense (e.g. flair.datasets vs flair.datasets.sequence_labeling, ...)
• added all tutorials from the other doc page
• fix weird behaivour of table of contents
• link all classes in the tutorials
• gather feedback about the basic design/setup to ensure this page as a long future.
• landing page designed to our wishes @alanakbik will do this in a separate MR later.
• add the flair icon
• improve toc structure - which pages should show which depth
• restructure version to be part of the header instead of the sidebar & hide ToC on main page.

The docs can be checkout locally and tested anytime by following the updating_documentation.md contributers guide. You know you have successfully built the docs, if you can watch the guide again in html format ;-)

[alanakbik]

Everything looks good - thanks a lot for making all these changes and improving the documentation across the board!

I am not able to run sphinx-multiversion docs doc_build locally - it is giving me a "No package metadata was found for flair" unless I also install flair in the virtual environment. But then I get a "outputdir 'doc-page' for refs/remotes/origin/doc-page conflicts with other versions" error. Maybe you can walk me through it?

I also not the deploy action is not working. Aside from these things, I would say it is ready to merge and see in action!

[alanakbik]

3.8 very soon, we need to remember that this info needs to be changed here as well.

[helpmefindaname]

is fixed

[alanakbik]

What does the "r" do?

[helpmefindaname]

the r prefix makes a string to a raw string meaning, that it doesn't use escape sequences etc.

for example r"\n" == "\\n" evaluates to a backslash followed by an n, while "\n" would evaluate to the enter symbol

[alanakbik]

Thanks a lot @helpmefindaname! This is really helpful and a big step towards improving our documentation!