chore: Upgrade Python requirements (#268)

* chore: Upgrade Python requirements
* build: build docs using sphinx directly instead of setuptools build_sphinx, which has been removed
* fix: ignore pylint too-many-positional-arguments
* build: fix coverage target to use drf-latest; Previous target wasn't being run.
* build: RTD with python3.12 + ubuntu-lts-latest
* build: handle upcoming RTD changes
  See https://about.readthedocs.com/blog/2024/07/addons-by-default/ for details
* chore: bumps package version to 3.8.1

.github/workflows/ci.yml

@@ -36,7 +36,7 @@ jobs:
       run: tox
 
     - name: Run Coverage
-      if: matrix.python-version == '3.12' && matrix.toxenv=='django42-drf314'
+      if: matrix.python-version == '3.12' && matrix.toxenv=='django42-drflatest'
       uses: codecov/codecov-action@v4
       with:
         flags: unittests

.readthedocs.yaml

@@ -12,9 +12,9 @@ sphinx:
 
 # Set the version of python needed to build these docs.
 build:
-  os: "ubuntu-22.04"
+  os: "ubuntu-lts-latest"
   tools:
-    python: "3.8"
+    python: "3.12"
 
 # Optionally install extra requirements required to build your docs
 python:

Makefile

@@ -28,8 +28,8 @@ clean: ## Remove generated byte code, coverage reports, and build artifacts
 	rm -fr dist/
 	rm -fr *.egg-info
 
-docs: ## generate Sphinx HTML documentation
-	python setup.py build_sphinx
+docs-html: ## generate Sphinx HTML documentation
+	make -C docs html
 
 dev_requirements: ## Install Dev Requirements
 	pip install -qr requirements/pip.txt

docs/source/conf.py

@@ -300,3 +300,14 @@
 # directory.
 html_logo = "https://logos.openedx.org/open-edx-logo-color.png"
 html_favicon = "https://logos.openedx.org/open-edx-favicon.ico"
+
+
+# -- Read the Docs Specific Configuration
+# Define the canonical URL if you are using a custom domain on Read the Docs
+html_baseurl = os.environ.get("READTHEDOCS_CANONICAL_URL", "")
+
+# Tell Jinja2 templates the build is running on Read the Docs
+if os.environ.get("READTHEDOCS", "") == "True":
+    if "html_context" not in globals():
+        html_context = {}
+    html_context["READTHEDOCS"] = True

requirements/base.txt

@@ -1,16 +1,11 @@
 #
-# This file is autogenerated by pip-compile with Python 3.8
+# This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
 #    make upgrade
 #
 asgiref==3.8.1
     # via django
-backports-zoneinfo==0.2.1 ; python_version < "3.9"
-    # via
-    #   -c requirements/constraints.txt
-    #   django
-    #   djangorestframework
 django==4.2.16
     # via
     #   -c requirements/common_constraints.txt
@@ -35,5 +30,3 @@ six==1.16.0
     # via edx-django-release-util
 sqlparse==0.5.1
     # via django
-typing-extensions==4.12.2
-    # via asgiref

requirements/ci.txt

@@ -1,5 +1,5 @@
 #
-# This file is autogenerated by pip-compile with Python 3.8
+# This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
 #    make upgrade
@@ -30,19 +30,19 @@ distlib==0.3.8
     #   virtualenv
 docopt==0.6.2
     # via coveralls
-filelock==3.16.0
+filelock==3.16.1
     # via
     #   -r requirements/tox.txt
     #   tox
     #   virtualenv
-idna==3.8
+idna==3.10
     # via requests
 packaging==24.1
     # via
     #   -r requirements/tox.txt
     #   pyproject-api
     #   tox
-platformdirs==4.3.2
+platformdirs==4.3.6
     # via
     #   -r requirements/tox.txt
     #   tox
@@ -51,23 +51,17 @@ pluggy==1.5.0
     # via
     #   -r requirements/tox.txt
     #   tox
-pyproject-api==1.7.1
+pyproject-api==1.8.0
     # via
     #   -r requirements/tox.txt
     #   tox
 requests==2.32.3
     # via coveralls
-tomli==2.0.1
-    # via
-    #   -r requirements/tox.txt
-    #   coverage
-    #   pyproject-api
-    #   tox
-tox==4.18.1
+tox==4.20.0
     # via -r requirements/tox.txt
 urllib3==2.2.3
     # via requests
-virtualenv==20.26.4
+virtualenv==20.26.5
     # via
     #   -r requirements/tox.txt
     #   tox

requirements/dev.txt

@@ -1,15 +1,15 @@
 #
-# This file is autogenerated by pip-compile with Python 3.8
+# This file is autogenerated by pip-compile with Python 3.12
 # by the following command:
 #
 #    make upgrade
 #
-accessible-pygments==0.0.4
+accessible-pygments==0.0.5
     # via
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
     #   pydata-sphinx-theme
-alabaster==0.7.13
+alabaster==1.0.0
     # via
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
@@ -20,7 +20,7 @@ asgiref==3.8.1
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
     #   django
-astroid==3.2.4
+astroid==3.3.4
     # via
     #   -r requirements/test.txt
     #   pylint
@@ -31,14 +31,6 @@ babel==2.16.0
     #   -r requirements/test.txt
     #   pydata-sphinx-theme
     #   sphinx
-backports-zoneinfo==0.2.1 ; python_version < "3.9"
-    # via
-    #   -c requirements/constraints.txt
-    #   -r requirements/base.txt
-    #   -r requirements/docs.txt
-    #   -r requirements/test.txt
-    #   django
-    #   djangorestframework
 beautifulsoup4==4.12.3
     # via
     #   -r requirements/docs.txt
@@ -98,7 +90,7 @@ djangorestframework==3.15.2
     #   -r requirements/base.txt
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
-docutils==0.19
+docutils==0.21.2
     # via
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
@@ -113,19 +105,15 @@ edx-lint==5.3.7
     # via
     #   -c requirements/constraints.txt
     #   -r requirements/test.txt
-exceptiongroup==1.2.2
-    # via
-    #   -r requirements/test.txt
-    #   pytest
 factory-boy==3.3.1
     # via -r requirements/test.txt
-faker==28.4.1
+faker==30.0.0
     # via
     #   -r requirements/test.txt
     #   factory-boy
 freezegun==1.5.1
     # via -r requirements/test.txt
-idna==3.8
+idna==3.10
     # via
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
@@ -135,11 +123,6 @@ imagesize==1.4.1
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
     #   sphinx
-importlib-metadata==8.5.0
-    # via
-    #   -r requirements/docs.txt
-    #   -r requirements/test.txt
-    #   sphinx
 iniconfig==2.0.0
     # via
     #   -r requirements/test.txt
@@ -181,7 +164,7 @@ pbr==6.1.0
     # via
     #   -r requirements/test.txt
     #   stevedore
-platformdirs==4.3.2
+platformdirs==4.3.6
     # via
     #   -r requirements/test.txt
     #   pylint
@@ -196,7 +179,7 @@ pockets==0.9.1
     #   sphinxcontrib-napoleon
 pycodestyle==2.12.1
     # via -r requirements/test.txt
-pydata-sphinx-theme==0.14.4
+pydata-sphinx-theme==0.15.4
     # via
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
@@ -208,7 +191,7 @@ pygments==2.18.0
     #   accessible-pygments
     #   pydata-sphinx-theme
     #   sphinx
-pylint==3.2.7
+pylint==3.3.1
     # via
     #   -r requirements/test.txt
     #   edx-lint
@@ -251,7 +234,6 @@ pytz==2024.2
     #   -r requirements/base.txt
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
-    #   babel
 pyyaml==6.0.2
     # via
     #   -r requirements/base.txt
@@ -284,27 +266,27 @@ soupsieve==2.6
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
     #   beautifulsoup4
-sphinx==6.2.1
+sphinx==8.0.2
     # via
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
     #   pydata-sphinx-theme
     #   sphinx-book-theme
-sphinx-book-theme==1.0.1
+sphinx-book-theme==1.1.3
     # via
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
-sphinxcontrib-applehelp==1.0.4
+sphinxcontrib-applehelp==2.0.0
     # via
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
     #   sphinx
-sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-devhelp==2.0.0
     # via
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
     #   sphinx
-sphinxcontrib-htmlhelp==2.0.1
+sphinxcontrib-htmlhelp==2.1.0
     # via
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
@@ -318,12 +300,12 @@ sphinxcontrib-napoleon==0.7
     # via
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
-sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-qthelp==2.0.0
     # via
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
     #   sphinx
-sphinxcontrib-serializinghtml==1.1.5
+sphinxcontrib-serializinghtml==2.0.0
     # via
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
@@ -342,32 +324,17 @@ text-unidecode==1.3
     # via
     #   -r requirements/test.txt
     #   python-slugify
-tomli==2.0.1
-    # via
-    #   -r requirements/test.txt
-    #   coverage
-    #   pylint
-    #   pytest
 tomlkit==0.13.2
     # via
     #   -r requirements/test.txt
     #   pylint
 typing-extensions==4.12.2
     # via
-    #   -r requirements/base.txt
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
-    #   asgiref
-    #   astroid
     #   pydata-sphinx-theme
-    #   pylint
 urllib3==2.2.3
     # via
     #   -r requirements/docs.txt
     #   -r requirements/test.txt
     #   requests
-zipp==3.20.1
-    # via
-    #   -r requirements/docs.txt
-    #   -r requirements/test.txt
-    #   importlib-metadata