Feature: Generate and Publish API Documentation on GitHub Pages

[SequeI]

This issue proposes the implementation of an automated process to generate and publish project API documentation on a GitHub Pages site. This will provide a user-friendly, browsable reference for the project's codebase.

• Evaluate tools like Pydoc, Sphinx, MkDocs, or pdoc.

• Create configuration files (e.g., conf.py for Sphinx or mkdocs.yml for MkDocs).

• Set up a new workflow file (e.g., .github/workflows/docs.yml).

• Include steps to install the documentation tool's dependencies.

• Add a step to generate the static documentation files.

• Add a step to publish the generated files to a dedicated branch (e.g., gh-pages) or to the docs folder for GitHub Pages.

• Enable GitHub Pages.