Specify Sphinx version >=1.8,<2 in dev dependencies #494
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.
Signed-off-by: Håkon Wiik Ånes [email protected]
Description
Docs aren't built successfully by Read The Docs because Sphinx is pinned to v1.7.6 in
requirements-dev.txt
, but #468 introduced a doc change which requires Sphinx v1.8 or newer. This PR updates the Sphinx version to>=1.8,<2
inrequirements-dev.txt
so that the docs can hopefully be built successfully.Related Issue
No open issues address that the docs fail, but this issue e.g. #389 cannot go on unless this is fixed.
Motivation and Context
We depend on PySwarms in PyEBSDIndex (https://github.com/USNavalResearchLaboratory/PyEBSDIndex) and would like for our dependencies to have an up-to-date documentation for our users to read.
How Has This Been Tested?
On Ubuntu 22.04.
Not tested, since I tried building the docs myself but got this error:
Types of changes
Checklist: