diff --git a/.readthedocs.yaml b/.readthedocs.yaml index a3dbd6cc..c45084fa 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -5,12 +5,17 @@ # Required: the version of this file's schema. version: 2 +build: + os: "ubuntu-20.04" + tools: + python: "3.8" + # Build documentation in the docs/ directory with Sphinx sphinx: configuration: docs/api/source/conf.py -# Optionally set the version of Python and requirements required to build your docs +# We recommend specifying your dependencies to enable reproducible builds: +# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: - version: "3.8" install: - requirements: requirements/doc.txt diff --git a/docs/api/source/conf.py b/docs/api/source/conf.py index 79a5ea85..829cfd35 100644 --- a/docs/api/source/conf.py +++ b/docs/api/source/conf.py @@ -60,6 +60,13 @@ "use_repository_button": True, "use_issues_button": True, "use_edit_page_button": True, + # False was the default value for navigation_with_keys. However, in version 0.14.2 of pydata-sphinx-theme, this default + # was removed and a warning was added that would be emitted whenever navigation_with_keys was not set. Because of the + # "SPHINXOPTS = -W" configuration in tox.ini, all warnings are promoted to an error. Therefore, it's necesary to set + # this value. I have set it to the default value explicitly. Please see the following GitHub comments for context. + # https://github.com/pydata/pydata-sphinx-theme/issues/1539 + # https://github.com/pydata/pydata-sphinx-theme/issues/987#issuecomment-1277214209 + "navigation_with_keys": False, # Please don't change unless you know what you're doing. "extra_footer": """ diff --git a/requirements/base.txt b/requirements/base.txt index 22c38a73..44635511 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -12,9 +12,9 @@ backports-zoneinfo==0.2.1 # via django boto==2.49.0 # via -r requirements/base.in -boto3==1.28.67 +boto3==1.28.73 # via -r requirements/base.in -botocore==1.31.67 +botocore==1.31.73 # via # boto3 # s3transfer @@ -24,7 +24,7 @@ cffi==1.16.0 # via # cryptography # pynacl -charset-normalizer==3.3.0 +charset-normalizer==3.3.1 # via requests click==8.1.7 # via edx-django-utils @@ -32,7 +32,7 @@ coreapi==2.3.3 # via -r requirements/base.in coreschema==0.0.4 # via coreapi -cryptography==41.0.4 +cryptography==41.0.5 # via # django-fernet-fields-v2 # pyjwt @@ -88,7 +88,7 @@ djangorestframework==3.14.0 # drf-yasg # edx-api-doc-tools # edx-drf-extensions -djangorestframework-csv==2.1.1 +djangorestframework-csv==3.0.1 # via -r requirements/base.in drf-jwt==1.19.2 # via edx-drf-extensions @@ -127,7 +127,7 @@ edx-rest-api-client==5.6.1 # edx-enterprise-data factory-boy==3.3.0 # via edx-enterprise-data -faker==19.11.0 +faker==19.12.0 # via factory-boy html5lib==1.1 # via -r requirements/base.in @@ -201,7 +201,6 @@ semantic-version==2.10.0 # via edx-drf-extensions six==1.16.0 # via - # djangorestframework-csv # edx-ccx-keys # edx-django-release-util # edx-rbac @@ -224,8 +223,6 @@ typing-extensions==4.8.0 # django-countries # edx-opaque-keys # faker -unicodecsv==0.14.1 - # via djangorestframework-csv uritemplate==4.1.1 # via # coreapi diff --git a/requirements/dev.txt b/requirements/dev.txt index f4eace4f..2a6a4110 100644 --- a/requirements/dev.txt +++ b/requirements/dev.txt @@ -12,9 +12,9 @@ backports-zoneinfo==0.2.1 # via django boto==2.49.0 # via -r requirements/base.in -boto3==1.28.67 +boto3==1.28.73 # via -r requirements/base.in -botocore==1.31.67 +botocore==1.31.73 # via # boto3 # s3transfer @@ -24,7 +24,7 @@ cffi==1.16.0 # via # cryptography # pynacl -charset-normalizer==3.3.0 +charset-normalizer==3.3.1 # via requests click==8.1.7 # via edx-django-utils @@ -32,7 +32,7 @@ coreapi==2.3.3 # via -r requirements/base.in coreschema==0.0.4 # via coreapi -cryptography==41.0.4 +cryptography==41.0.5 # via # django-fernet-fields-v2 # pyjwt @@ -88,7 +88,7 @@ djangorestframework==3.14.0 # drf-yasg # edx-api-doc-tools # edx-drf-extensions -djangorestframework-csv==2.1.1 +djangorestframework-csv==3.0.1 # via -r requirements/base.in drf-jwt==1.19.2 # via edx-drf-extensions @@ -127,7 +127,7 @@ edx-rest-api-client==5.6.1 # edx-enterprise-data factory-boy==3.3.0 # via edx-enterprise-data -faker==19.11.0 +faker==19.12.0 # via factory-boy html5lib==1.1 # via -r requirements/base.in @@ -203,7 +203,6 @@ semantic-version==2.10.0 # via edx-drf-extensions six==1.16.0 # via - # djangorestframework-csv # edx-ccx-keys # edx-django-release-util # edx-rbac @@ -226,8 +225,6 @@ typing-extensions==4.8.0 # django-countries # edx-opaque-keys # faker -unicodecsv==0.14.1 - # via djangorestframework-csv uritemplate==4.1.1 # via # coreapi diff --git a/requirements/doc.txt b/requirements/doc.txt index a897dbb7..c064d3e5 100644 --- a/requirements/doc.txt +++ b/requirements/doc.txt @@ -12,7 +12,7 @@ asgiref==3.7.2 # via # django # django-countries -babel==2.13.0 +babel==2.13.1 # via # pydata-sphinx-theme # sphinx @@ -22,9 +22,9 @@ beautifulsoup4==4.12.2 # via pydata-sphinx-theme boto==2.49.0 # via -r requirements/base.in -boto3==1.28.67 +boto3==1.28.73 # via -r requirements/base.in -botocore==1.31.67 +botocore==1.31.73 # via # boto3 # s3transfer @@ -34,7 +34,7 @@ cffi==1.16.0 # via # cryptography # pynacl -charset-normalizer==3.3.0 +charset-normalizer==3.3.1 # via requests click==8.1.7 # via edx-django-utils @@ -42,7 +42,7 @@ coreapi==2.3.3 # via -r requirements/base.in coreschema==0.0.4 # via coreapi -cryptography==41.0.4 +cryptography==41.0.5 # via # django-fernet-fields-v2 # pyjwt @@ -98,7 +98,7 @@ djangorestframework==3.14.0 # drf-yasg # edx-api-doc-tools # edx-drf-extensions -djangorestframework-csv==2.1.1 +djangorestframework-csv==3.0.1 # via -r requirements/base.in docutils==0.19 # via @@ -141,7 +141,7 @@ edx-rest-api-client==5.6.1 # edx-enterprise-data factory-boy==3.3.0 # via edx-enterprise-data -faker==19.11.0 +faker==19.12.0 # via factory-boy html5lib==1.1 # via -r requirements/base.in @@ -186,7 +186,7 @@ psutil==5.9.6 # via edx-django-utils pycparser==2.21 # via cffi -pydata-sphinx-theme==0.14.1 +pydata-sphinx-theme==0.14.2 # via sphinx-book-theme pygments==2.16.1 # via @@ -235,7 +235,6 @@ semantic-version==2.10.0 # via edx-drf-extensions six==1.16.0 # via - # djangorestframework-csv # edx-ccx-keys # edx-django-release-util # edx-rbac @@ -282,8 +281,6 @@ typing-extensions==4.8.0 # edx-opaque-keys # faker # pydata-sphinx-theme -unicodecsv==0.14.1 - # via djangorestframework-csv uritemplate==4.1.1 # via # coreapi diff --git a/requirements/pip.txt b/requirements/pip.txt index 6a9dafe8..6778a0a4 100644 --- a/requirements/pip.txt +++ b/requirements/pip.txt @@ -8,7 +8,7 @@ wheel==0.41.2 # via -r requirements/pip.in # The following packages are considered to be unsafe in a requirements file: -pip==23.3 +pip==23.3.1 # via -r requirements/pip.in setuptools==68.2.2 # via -r requirements/pip.in diff --git a/requirements/production.txt b/requirements/production.txt index ced7da13..cf80a9db 100644 --- a/requirements/production.txt +++ b/requirements/production.txt @@ -12,9 +12,9 @@ backports-zoneinfo==0.2.1 # via django boto==2.49.0 # via -r requirements/base.in -boto3==1.28.67 +boto3==1.28.73 # via -r requirements/base.in -botocore==1.31.67 +botocore==1.31.73 # via # boto3 # s3transfer @@ -24,7 +24,7 @@ cffi==1.16.0 # via # cryptography # pynacl -charset-normalizer==3.3.0 +charset-normalizer==3.3.1 # via requests click==8.1.7 # via edx-django-utils @@ -32,7 +32,7 @@ coreapi==2.3.3 # via -r requirements/base.in coreschema==0.0.4 # via coreapi -cryptography==41.0.4 +cryptography==41.0.5 # via # django-fernet-fields-v2 # pyjwt @@ -88,7 +88,7 @@ djangorestframework==3.14.0 # drf-yasg # edx-api-doc-tools # edx-drf-extensions -djangorestframework-csv==2.1.1 +djangorestframework-csv==3.0.1 # via -r requirements/base.in drf-jwt==1.19.2 # via edx-drf-extensions @@ -127,11 +127,11 @@ edx-rest-api-client==5.6.1 # edx-enterprise-data factory-boy==3.3.0 # via edx-enterprise-data -faker==19.11.0 +faker==19.12.0 # via factory-boy gevent==23.9.1 # via -r requirements/production.in -greenlet==3.0.0 +greenlet==3.0.1 # via gevent gunicorn==21.2.0 # via -r requirements/production.in @@ -216,7 +216,6 @@ semantic-version==2.10.0 # via edx-drf-extensions six==1.16.0 # via - # djangorestframework-csv # edx-ccx-keys # edx-django-release-util # edx-rbac @@ -239,8 +238,6 @@ typing-extensions==4.8.0 # django-countries # edx-opaque-keys # faker -unicodecsv==0.14.1 - # via djangorestframework-csv uritemplate==4.1.1 # via # coreapi diff --git a/requirements/test.txt b/requirements/test.txt index b2345094..6bca6222 100644 --- a/requirements/test.txt +++ b/requirements/test.txt @@ -14,9 +14,9 @@ backports-zoneinfo==0.2.1 # via django boto==2.49.0 # via -r requirements/base.in -boto3==1.28.67 +boto3==1.28.73 # via -r requirements/base.in -botocore==1.31.67 +botocore==1.31.73 # via # boto3 # s3transfer @@ -28,7 +28,7 @@ cffi==1.16.0 # pynacl chardet==5.2.0 # via diff-cover -charset-normalizer==3.3.0 +charset-normalizer==3.3.1 # via requests click==8.1.7 # via edx-django-utils @@ -40,7 +40,7 @@ coverage[toml]==7.3.2 # via # -r requirements/test.in # pytest-cov -cryptography==41.0.4 +cryptography==41.0.5 # via # django-fernet-fields-v2 # pyjwt @@ -101,7 +101,7 @@ djangorestframework==3.14.0 # drf-yasg # edx-api-doc-tools # edx-drf-extensions -djangorestframework-csv==2.1.1 +djangorestframework-csv==3.0.1 # via -r requirements/base.in drf-jwt==1.19.2 # via edx-drf-extensions @@ -142,7 +142,7 @@ exceptiongroup==1.1.3 # via pytest factory-boy==3.3.0 # via edx-enterprise-data -faker==19.11.0 +faker==19.12.0 # via factory-boy freezegun==1.2.2 # via -r requirements/test.in @@ -215,7 +215,7 @@ pymongo==3.13.0 # via edx-opaque-keys pynacl==1.5.0 # via edx-django-utils -pytest==7.4.2 +pytest==7.4.3 # via # pytest-cov # pytest-django @@ -259,7 +259,6 @@ semantic-version==2.10.0 six==1.16.0 # via # astroid - # djangorestframework-csv # edx-ccx-keys # edx-django-release-util # edx-rbac @@ -290,8 +289,6 @@ typing-extensions==4.8.0 # django-countries # edx-opaque-keys # faker -unicodecsv==0.14.1 - # via djangorestframework-csv uritemplate==4.1.1 # via # coreapi diff --git a/requirements/tox.txt b/requirements/tox.txt index eccfb110..214f9f14 100644 --- a/requirements/tox.txt +++ b/requirements/tox.txt @@ -6,7 +6,7 @@ # distlib==0.3.7 # via virtualenv -filelock==3.12.4 +filelock==3.13.0 # via # tox # virtualenv @@ -29,5 +29,5 @@ tox==3.28.0 # tox-battery tox-battery==0.6.2 # via -r requirements/tox.in -virtualenv==20.24.5 +virtualenv==20.24.6 # via tox