Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Pin Sphinx plugins to compatible versions #1803

Merged
merged 3 commits into from
Jan 16, 2024
Merged

Pin Sphinx plugins to compatible versions #1803

merged 3 commits into from
Jan 16, 2024

Commits on Jan 15, 2024

  1. Pin Sphinx plugins to compatible versions 

    This fixes version incompatibilities with major version 4 of
Sphinx, which GitPython is still using for the time being. Some
plugins that previously had depended back on Sphinx have had those
dependencies removed to avoid dependency cycles, but the effect is
that `pip` no longer is aware of or able to enforce version
compatibility, and newer plugin versions than can actually run with
Sphinx 4 are installed instead of older, usable versions.

This fixes the problem by pinning each of the affected Sphinx
plugins' latest actually compatible versions, i.e., latest versions
that do not need Sphinx 5 or higher.

The alternative of moving to Sphinx 5 or higher should probably be
done eventually, but will require addressing a cross-reference
ambiguity in type annotations for the `Actor` class.

For details on the bug, see:

- gitpython-developers#1799 (comment)
- gitpython-developers#1802
    @EliahKagan
    EliahKagan committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    b061a01 View commit details
    Browse the repository at this point in the history

  2. Extend plugin version ranges down for Python 3.7 

    This uses narrow ranges, rather than pinning single versions, for
two of the Sphinx plugins whose versions are recently pinned.

This is so that plugin versions compatible with Python 3.7 (which
GitPython still supports) can be selected.
    @EliahKagan
    EliahKagan committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    370822c View commit details
    Browse the repository at this point in the history

  3. Bump Sphinx from 4.3.0 to 4.3.2 

    Although 4.4.0 or greater do not seem usable for the time being due
to finding "more than one target found for cross-reference 'Actor'"
as examined in gitpython-developers#1802, bugfixes from 4.3.* patch releases are okay.
    @EliahKagan
    EliahKagan committed Jan 15, 2024
    Configuration menu
    Copy the full SHA
    74ef6c7 View commit details
    Browse the repository at this point in the history