[docs] Setup Mkdocs Material using Github Pages

[cricksmaidiene]

About

Currently, our Python codebase lacks proper documentation, which makes it challenging for new contributors and maintainers to understand the codebase's functionality. To address this issue, we need to set up MkDocs Material to generate documentation from the Python function docstrings and deploy it on GitHub Pages.

The goal of this issue is to improve the documentation of our codebase and make it easily accessible to all contributors and maintainers. We will use MkDocs Material to generate documentation from the Python function docstrings. This will allow us to write documentation alongside the code and keep it up to date with any changes made to the code. Furthermore, the documentation will be generated automatically, ensuring that it stays up to date with any changes made to the code.

Steps

The steps involved in this issue are as follows:

1. Install MkDocs Material and any necessary dependencies.
2. Create a new MkDocs project in the root directory of our codebase (docs).
3. Configure MkDocs to generate documentation from the Python function docstrings.
4. Add any additional documentation pages that are required.
5. Deploy the generated documentation to GitHub Pages.

Reference

The [Dotlas Cookiecutter Pypackage] has a template for setting up mkdocs, but does not configure github pages automatically. That can be used as a reference to generate mkdocs for this project.