Add support for multiversion docs hosted via github pages

[amrit110]

PR Type

Documentation, enhancement

Short Description

• Add support for multi-version docs hosted via github pages
• Remove the develop branch references in the github workflows, we are not using a develop branch anymore
• Every time there is a PR, the building of docs happens in CI, but nothing is deployed. The main branch documentation is tagged as "main", while releases create a versioned doc with the "latest" alias for the latest one.

To test locally:

1. uv sync --dev --group docs
2. mike deploy 0.5.0 latest
3. mike deploy main
4. mike set-default 0.5.0
5. mike serve

Note that previous versions like 0.4.0, etc won't have docs. We would have to manually add them if needed.

[Copilot]

Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 comment.

Files not reviewed (1)

• docs/stylesheets/extra.css: Language not supported

[Copilot]

Copilot reviewed 5 out of 6 changed files in this pull request and generated no comments.

Files not reviewed (1)

• docs/stylesheets/extra.css: Language not supported

Comments suppressed due to low confidence (1)

.github/workflows/docs.yml:144

• The regex used to extract the version from pyproject.toml may fail if additional whitespace or formatting changes occur. Consider using a dedicated TOML parser for more robust version extraction.

VERSION=$(grep -m 1 '^version = ' pyproject.toml | sed 's/^version = "\(.*\)"$/\1/')