Adjust the RTD dependencies for old sphinx version #388
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
mbeacom
commented
Jan 10, 2023
| @@ -1,5 +1,3 @@ | |||
| # -*- coding: utf-8 -*- | |||
There was a problem hiding this comment.
This is superfluous in python 3 as source files are decoded as utf-8 by default.
mbeacom
commented
Jan 10, 2023
| @@ -23,7 +21,7 @@ | |||
| # -- Project information ----------------------------------------------------- | |||
|
|
|||
| project = "RDK" | |||
| copyright = "2017-2022 Amazon.com, Inc. or its affiliates. All Rights Reserved" | |||
| copyright = "2017-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved" | |||
There was a problem hiding this comment.
We likely shouldn't be maintaining a range, but rather the original year of copyright per OSS guidance. That said, since we're maintaining a range already, updating it to show we're still maintaining the project :D
mbeacom
commented
Jan 10, 2023
| @@ -3,4 +3,4 @@ sphinx-argparse==0.2.5 | |||
| sphinx-rtd-theme==0.4.3 | |||
| sphinxcontrib-websupport==1.1.0 | |||
| PyYAML==5.4.1 | |||
|
|
|||
| jinja2<3.1.0 | |||
There was a problem hiding this comment.
This is the specific dep pinning defined in the attached issues remediation steps.
Merged
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.
Issue #, if available: #386
Description of changes: The goal of this PR is to resolve the RTD build failures (similar to here: https://readthedocs.org/projects/aws-config-rdk/builds/19116212/) -- the encountered failure is described here: readthedocs/readthedocs.org#9037
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.