Skip to content

fix: drop unused docs dependency group#1044

Merged
ajbozarth merged 1 commit into
generative-computing:mainfrom
ajbozarth:fix/drop-unused-docs-deps
May 8, 2026
Merged

fix: drop unused docs dependency group#1044
ajbozarth merged 1 commit into
generative-computing:mainfrom
ajbozarth:fix/drop-unused-docs-deps

Conversation

@ajbozarth
Copy link
Copy Markdown
Contributor

Misc PR

Type of PR

  • Bug Fix
  • New Feature
  • Documentation
  • Other

Description

  • Link to Issue: Fixes

The docs dependency group in pyproject.toml was a legacy leftover from the pre-Mintlify Sphinx setup. Nothing in mellea/, cli/, docs/, tooling/, or test/ imports any of its packages (sphinx_rtd_theme, sphinx-autodoc-typehints, sphinx_mdinclude) — docs are now built via Mintlify (docs/docs/docs.json) and tooling/docs-autogen/.

The group transitively installed sphinx itself, and starting with sphinx 9.1.0 (released 2025-12-31), sphinx adopted PEP 695 type statement syntax. Our mypy config pins python_version = "3.11", so fresh uv sync runs after ~March 2026 started failing the mypy pre-commit hook with:

.venv/lib/python3.12/site-packages/sphinx/ext/autodoc/_property_types.py:30:
  error: Type statement is only supported in Python 3.12 and greater  [syntax]

If you searched for that error and landed here: the previous workaround was uv pip uninstall sphinx, but the real fix is to drop the unused group entirely (this PR).

Followup from #1041, which hit this same issue during commit.

Testing

  • Tests added to the respective file if code was changed
  • New code has 100% coverage if code as added
  • Ensure existing tests and github automation passes (a maintainer will kick off the github automation when the rest of the PR is populated)

(Pure deletion — no new code to test. Verified locally: uv run mypy . now passes without the sphinx workaround; uv run ruff format/check clean.)

Attribution

  • AI coding assistants used

The `docs` group in pyproject.toml was legacy from the pre-Mintlify
Sphinx setup — nothing in mellea/, cli/, docs/, tooling/, or test/
imports sphinx_rtd_theme, sphinx-autodoc-typehints, or sphinx_mdinclude
anymore (docs are now built from docs/docs/docs.json + tooling/docs-autogen/).

The group transitively installs sphinx itself. Sphinx 9.1.0 (2025-12-31)
adopted PEP 695 `type` statement syntax, which mypy rejects under our
pinned python_version = "3.11", breaking fresh `uv sync` runs with:

    .venv/.../sphinx/ext/autodoc/_property_types.py:30:
    error: Type statement is only supported in Python 3.12 and greater

Workaround until now: `uv pip uninstall sphinx`. Real fix: drop the
unused group. Also removes the orphaned "Documentation and notebooks"
comment since only the notebook group remains.

Assisted-by: Claude Code
Signed-off-by: Alex Bozarth <ajbozart@us.ibm.com>
@ajbozarth ajbozarth requested a review from a team as a code owner May 8, 2026 01:16
@ajbozarth ajbozarth requested a review from markstur May 8, 2026 01:16
@ajbozarth ajbozarth self-assigned this May 8, 2026
@ajbozarth ajbozarth requested a review from jakelorocco May 8, 2026 01:16
@github-actions github-actions Bot added the bug Something isn't working label May 8, 2026
@ajbozarth ajbozarth added this pull request to the merge queue May 8, 2026
Merged via the queue into generative-computing:main with commit ab3cbbf May 8, 2026
7 checks passed
@ajbozarth ajbozarth deleted the fix/drop-unused-docs-deps branch May 8, 2026 16:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants