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.

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

Fix dependency conflicts in pyproject.toml #1548

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

dgmcdona
Copy link
Contributor

@dgmcdona dgmcdona commented Jan 14, 2025

Closes #1546

This makes three changes to fix dependency resolution

  • Fixes a bug where the sphinx version is unresolvable, and pins it to
    8.0.2 (the minimum version required by the minimum version of
    sphinx-autodoc-typehints)
  • Lowers the required version of pefile in order to allow us to use
    the pyinstaller version specified in the dev dependencies
  • Bumps the python version to 3.10 in order to support sphinx 8.0.2

I know bumping the minimum Python version is not desirable, but I wasn't sure which sphinx/sphinx-autodoc-typehints versions would be acceptable due to my unfamiliarity with our doc requirements. We can lower those if an acceptable version can be found that supports python 3.8. There isn't a way to specify different required Python versions for different sets of dependencies within pyproject.toml.

This makes three changes to fix dependency resolution
- Fixes a bug where the sphinx version is unresolvable, and pins it to
  8.0.2 (the minimum version required by the minimum version of
  sphinx-autodoc-typehints)
- Lowers the required version of `pefile` in order to allow us to use
  the `pyinstaller` version specified in the `dev` dependencies
- Bumps the python version to 3.10 in order to support sphinx 8.0.2
@dgmcdona
Copy link
Contributor Author

I reverted the Python version bumps and found the highest versions of sphinx-autodoc-typehints and sphinx that still support Python 3.8. Installing those versions and building the docs with cd doc; make html seemed to work fine, although there are some existing syntax errors within the documentation that don't cause the build to fail.

I also looked through the git history to see if there was a reason that we require such a high version of pefile and couldn't find one, it seems that it was bumped in this commit

This lowers the required versions of sphinx and sphinx-autodoc-typehints
to the highest versions that still support Python 3.8.
@dgmcdona dgmcdona force-pushed the issue_1546_dependency_conflicts branch from a1d8e1c to 055c8db Compare January 14, 2025 22:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

pyproject.toml: dependency conflicts
1 participant