Migrate Shapash documentation from Sphinx to MkDocs

[guillaume-vignal]

Description:

Currently, the Shapash documentation is built using Sphinx and hosted on ReadTheDocs. While this setup works, it may be beneficial to migrate the documentation to MkDocs, for the following reasons:

Why MkDocs?

• Markdown-based: MkDocs uses Markdown files instead of reStructuredText, which is simpler and more commonly used by contributors.
• Better GitHub integration: MkDocs can be easily deployed via GitHub Pages, allowing the documentation to be fully integrated into the GitHub ecosystem.
• Modern UI: Themes like mkdocs-material offer a clean, responsive, and user-friendly interface out of the box.
• Simpler configuration: Compared to Sphinx, MkDocs has a more straightforward configuration and build process.

Suggested Actions

1. Set up a basic MkDocs structure with mkdocs.yml and docs/ directory.
2. Migrate existing documentation from .rst to .md format.
3. Choose and configure an appropriate MkDocs theme (e.g. mkdocs-material).
4. Set up GitHub Actions or another CI tool for automatic deployment on GitHub Pages.
5. Update contribution guidelines with new documentation instructions.

Optional

• Add versioning support using mike or similar tools.
• Integrate search functionality (native or via plugins).