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.

Sign up for GitHub

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

Adjust the RTD dependencies for old sphinx version #388

Merged
merged 1 commit into from
Jan 10, 2023
Merged

Adjust the RTD dependencies for old sphinx version #388

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 1 addition & 3 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
# -*- coding: utf-8 -*-
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is superfluous in python 3 as source files are decoded as utf-8 by default.

#
# Configuration file for the Sphinx documentation builder.
#
# This file does only contain a selection of the most common options. For a
Expand All @@ -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"
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

author = "RDK Maintainers"

# The short X.Y version
Expand Down
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the specific dep pinning defined in the attached issues remediation steps.