Enable versioned documentation preview

[laserkelvin]

ALCHEMI Toolkit Pull Request

Description

Adds the general workflow for automated CI/CD building of documentation, with versioning so that users can view documentation produced for different version tags.

Type of Change

• Bug fix (non-breaking change that fixes an issue)
• New feature (non-breaking change that adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Performance improvement
• Documentation update
• Refactoring (no functional changes)
• CI/CD or infrastructure change

Related Issues

None.

Changes Made

• Adds a local preview workflow for building and serving versioned docs.
• Wires the PyData version switcher into the generated docs site.
• Extends the docs CI artifact checks so the switcher output is verified before deployment.

Testing

• Unit tests pass locally (make pytest)
• Linting passes (make lint)
• New tests added for new functionality meets coverage expectations?

Manual checks run:

• make docs-versioned-preview
• make docs-versioned-serve
• curl -I http://127.0.0.1:8000/main/
• curl -s http://127.0.0.1:8000/_static/switcher.json
• uv run ruff check docs/build_versioned.py docs/conf.py
• git diff --check

Checklist

• I have read and understand the Contributing Guidelines
• I have updated the CHANGELOG.md
• I have performed a self-review of my code
• I have added docstrings to new functions/classes
• I have updated the documentation (if applicable)

Additional Notes

This keeps the docs workflow in a manual, artifact-first mode. The generated site can be inspected before we add the final GitHub Pages publish step.

[copy-pr-bot]

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.