chore: deprecate edx sphinx theme

.github/workflows/ci.yml

@@ -15,24 +15,24 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.8']
-        toxenv: [quality, docs, 'py38']
+        python-version: ['3.12']
+        toxenv: [quality, docs, 'py312']
     env:
       RUNJSHINT: true
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-python@v2
         with:
-          python-version: '3.8'
+          python-version: '3.12'
           architecture: x64
       - run: pip install -r requirements/ci.txt
       - name: Run tox
         env:
           TOXENV: ${{ matrix.toxenv }}
         run: tox
       - name: Run Coverage
-        if: matrix.toxenv == 'py38'
+        if: matrix.toxenv == 'py312'
         uses: codecov/codecov-action@v3
         with:
           flags: unittests
-          fail_ci_if_error: true
+          fail_ci_if_error: false

.gitignore

@@ -20,6 +20,8 @@ __pycache__
 /.installed.cfg
 /lib
 /lib64
+venv
+.idea
 
 # Installer logs
 pip-log.txt

docs/conf.py

@@ -15,8 +15,8 @@
 import re
 import sys
 from subprocess import check_call
-
-import edx_theme
+from datetime import datetime
+import sphinx_book_theme
 
 
 def get_version(*file_paths):
@@ -59,7 +59,6 @@ def get_version(*file_paths):
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'edx_theme',
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
@@ -90,8 +89,8 @@ def get_version(*file_paths):
 
 # General information about the project.
 project = 'getsmarter-api-clients'
-copyright = edx_theme.COPYRIGHT  # pylint: disable=redefined-builtin
-author = edx_theme.AUTHOR
+copyright = f'{datetime.now().year}, edX LLC.'  # pylint: disable=redefined-builtin
+author = 'edX LLC'
 project_title = 'getsmarter-api-clients'
 documentation_title = f"{project_title}"
 
@@ -172,16 +171,7 @@ def get_version(*file_paths):
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 
-html_theme = 'edx_theme'
-
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#
-# html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [edx_theme.get_html_theme_path()]
+html_theme = 'sphinx_book_theme'
 
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.

pylintrc

@@ -2,7 +2,7 @@
 # ** DO NOT EDIT THIS FILE **
 # ***************************
 #
-# This file was generated by edx-lint: https://github.com/edx/edx-lint
+# This file was generated by edx-lint: https://github.com/openedx/edx-lint
 #
 # If you want to change this file, you have two choices, depending on whether
 # you want to make a local change that applies only to this repo, or whether
@@ -28,7 +28,7 @@
 # CENTRAL CHANGE:
 #
 # 1. Edit the pylintrc file in the edx-lint repo at
-#    https://github.com/edx/edx-lint/blob/master/edx_lint/files/pylintrc
+#    https://github.com/openedx/edx-lint/blob/master/edx_lint/files/pylintrc
 #
 # 2. install the updated version of edx-lint (in edx-lint):
 #
@@ -64,7 +64,7 @@
 # SERIOUSLY.
 #
 # ------------------------------
-# Generated by edx-lint version: 5.2.4
+# Generated by edx-lint version: 5.4.1
 # ------------------------------
 [MASTER]
 ignore = migrations
@@ -259,6 +259,7 @@ enable =
 	useless-suppression,
 disable = 
 	bad-indentation,
+	broad-exception-raised,
 	consider-using-f-string,
 	duplicate-code,
 	file-ignored,
@@ -286,8 +287,10 @@ disable =
 	illegal-waffle-usage,
 
 	logging-fstring-interpolation,
+	broad-exception-caught,
 	consider-using-with,
 	bad-option-value,
+	too-many-positional-arguments
 
 [REPORTS]
 output-format = text
@@ -382,6 +385,6 @@ ext-import-graph =
 int-import-graph = 
 
 [EXCEPTIONS]
-overgeneral-exceptions = Exception
+overgeneral-exceptions = builtins.Exception
 
-# d6bc12479acb6afea1e73ae451442ce6695cb05b
+# c361d0e1560dd583e9500aeb19e05008d92d4349

pylintrc_tweaks

@@ -5,5 +5,7 @@ load-plugins = edx_lint.pylint,pylint_celery
 
 [MESSAGES CONTROL]
 disable+ =
+    broad-exception-caught,
     consider-using-with,
     bad-option-value,
+    too-many-positional-arguments

requirements/base.txt

@@ -1,60 +1,56 @@
 #
-# 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.7.2
+asgiref==3.8.1
     # via django
-certifi==2023.7.22
+certifi==2024.8.30
     # via requests
-cffi==1.16.0
+cffi==1.17.1
     # via pynacl
-charset-normalizer==3.3.1
+charset-normalizer==3.4.0
     # via requests
 click==8.1.7
     # via edx-django-utils
-django==3.2.22
+django==4.2.16
     # via
     #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
     #   django-crum
     #   django-waffle
     #   edx-django-utils
 django-crum==0.7.9
     # via edx-django-utils
-django-waffle==4.0.0
+django-waffle==4.1.0
     # via edx-django-utils
-edx-django-utils==5.7.0
+edx-django-utils==7.0.0
     # via -r requirements/base.in
-idna==3.4
+idna==3.10
     # via requests
-newrelic==9.1.1
+newrelic==10.2.0
     # via edx-django-utils
 oauthlib==3.2.2
     # via
     #   -r requirements/base.in
     #   requests-oauthlib
-pbr==5.11.1
+pbr==6.1.0
     # via stevedore
-psutil==5.9.6
+psutil==6.1.0
     # via edx-django-utils
-pycparser==2.21
+pycparser==2.22
     # via cffi
 pynacl==1.5.0
     # via edx-django-utils
-pytz==2023.3.post1
-    # via
-    #   -r requirements/base.in
-    #   django
-requests==2.31.0
+pytz==2024.2
+    # via -r requirements/base.in
+requests==2.32.3
     # via requests-oauthlib
-requests-oauthlib==1.3.1
+requests-oauthlib==2.0.0
     # via -r requirements/base.in
-sqlparse==0.4.4
+sqlparse==0.5.1
     # via django
-stevedore==5.1.0
+stevedore==5.3.0
     # via edx-django-utils
-typing-extensions==4.8.0
-    # via asgiref
-urllib3==2.0.7
+urllib3==2.2.3
     # via requests

requirements/ci.txt

@@ -1,28 +1,34 @@
 #
-# 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
 #
-distlib==0.3.7
+cachetools==5.5.0
+    # via tox
+chardet==5.2.0
+    # via tox
+colorama==0.4.6
+    # via tox
+distlib==0.3.9
     # via virtualenv
-filelock==3.12.4
+filelock==3.16.1
     # via
     #   tox
     #   virtualenv
-packaging==23.2
-    # via tox
-platformdirs==3.11.0
-    # via virtualenv
-pluggy==1.3.0
-    # via tox
-py==1.11.0
-    # via tox
-six==1.16.0
+packaging==24.1
+    # via
+    #   pyproject-api
+    #   tox
+platformdirs==4.3.6
+    # via
+    #   tox
+    #   virtualenv
+pluggy==1.5.0
     # via tox
-tomli==2.0.1
+pyproject-api==1.8.0
     # via tox
-tox==3.28.0
+tox==4.23.2
     # via -r requirements/ci.in
-virtualenv==20.24.5
+virtualenv==20.27.1
     # via tox