Sphinx: remove 2.2.2 restriction and update readme regarding building source code docs locally #11973
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.
Hi,
Possible oversight when Sphinx was introduced:
Link to issue number:
None
Summary of the issue:
When Sphinx was introduced, readme wasn't updated to point out that source code documentation can be built in Python 3 version of NVDA. Also, used this opportunity to remove Sphinx version restriction (latest release is 3.4.1, which succeeds in building source code docs).
Description of how this pull request fixes the issue:
Updates:
Sphinx requirement: remove version restriction.
Testing performed:
Built NVDA dev docs with Sphinx 2.2.2 and 3.4.1 with both succeeding.
Known issues with pull request:
None
Change log entry:
None
Thanks.