strictly depend on sphinx's minor version #498
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Breathe closely integrates with many of Sphinx's internals, especially integration with Sphinx's C and C++ domains is rather fragile. Changes often need to be made in both Breathe and Sphinx at the same time. By pinning the Sphinx minor version in the dependency list it is ensured only versions that have been (mostly) verified to be compatible with each other are used, which prevents unexpected breakage. This is often the case if only Breathe's or only Sphinx's version is pinned in a project's dependency list.
|
The version string specification can be found in PEP 508, see https://www.python.org/dev/peps/pep-0508/. CICD is intentionally not changed to only use 3.0.x, as also running on 3.x serves as an early warning system during development of Breathe. @jakobandersen can you check? Ref: #497, specifically #497 (comment). |
vermeeren
added
analysis
|
Looks good to me (though my knowledge of Python packaging is somewhat limited). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Breathe closely integrates with many of Sphinx's internals, especially
integration with Sphinx's C and C++ domains is rather fragile. Changes
often need to be made in both Breathe and Sphinx at the same time.
By pinning the Sphinx minor version in the dependency list it is ensured
only versions that have been (mostly) verified to be compatible with
each other are used, which prevents unexpected breakage. This is often
the case if only Breathe's or only Sphinx's version is pinned in a
project's dependency list.