chore: deprecate edx-spinx-theme

docs/conf.py

@@ -15,8 +15,8 @@
 import re
 import sys
 from subprocess import check_call
+import sphinx_book_theme
 
-import edx_theme
 
 
 def get_version(*file_paths):
@@ -59,7 +59,7 @@ def get_version(*file_paths):
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
-    'edx_theme',
+    'sphinx_book_theme',
     'sphinx.ext.autodoc',
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
@@ -90,8 +90,8 @@ def get_version(*file_paths):
 
 # General information about the project.
 project = 'edx_exams'
-copyright = edx_theme.COPYRIGHT  # pylint: disable=redefined-builtin
-author = edx_theme.AUTHOR
+copyright = 'test'  # pylint: disable=redefined-builtin
+author = 'test'
 project_title = 'edx_exams'
 documentation_title = f"{project_title}"
 
@@ -172,16 +172,43 @@ 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'
+html_theme = 'sphinx_book_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 = {}
+html_theme_options = {
+    "repository_url": "https://github.com/edx/edx-exams",
+    "repository_branch": 'main',
+    "path_to_docs": "docs/",
+    "use_repository_button": True,
+    "use_issues_button": True,
+    "use_edit_page_button": True,
+    # Please don't change unless you know what you're doing.
+    "extra_footer": """
+        <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/">
+            <img
+                alt="Creative Commons License"
+                style="border-width:0"
+                src="https://i.creativecommons.org/l/by-sa/4.0/80x15.png"/>
+        </a>
+        <br>
+        These works by
+            <a
+                xmlns:cc="https://creativecommons.org/ns#"
+                href="https://openedx.org"
+                property="cc:attributionName"
+                rel="cc:attributionURL"
+            >Axim Collaborative</a>
+        are licensed under a
+            <a
+                rel="license"
+                href="https://creativecommons.org/licenses/by-sa/4.0/"
+            >Creative Commons Attribution-ShareAlike 4.0 International License</a>.
+    """
+}
 
-# Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [edx_theme.get_html_theme_path()]
 
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.

requirements/base.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.9
 # by the following command:
 #
 #    make upgrade
@@ -17,10 +17,6 @@ attrs==23.2.0
     #   -r requirements/base.in
     #   lti-consumer-xblock
     #   openedx-events
-backports-zoneinfo==0.2.1
-    # via
-    #   django
-    #   djangorestframework
 bleach==6.1.0
     # via lti-consumer-xblock
 boto3==1.34.149

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.9
 # by the following command:
 #
 #    make upgrade

requirements/dev.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.9
 # by the following command:
 #
 #    make upgrade
@@ -31,11 +31,6 @@ backports-tarfile==1.2.0
     # via
     #   -r requirements/validation.txt
     #   jaraco-context
-backports-zoneinfo==0.2.1
-    # via
-    #   -r requirements/validation.txt
-    #   django
-    #   djangorestframework
 bleach==6.1.0
     # via
     #   -r requirements/validation.txt
@@ -219,7 +214,7 @@ dnspython==2.6.1
     # via
     #   -r requirements/validation.txt
     #   pymongo
-docutils==0.20.1
+docutils==0.21.2
     # via
     #   -r requirements/validation.txt
     #   readme-renderer
@@ -324,10 +319,6 @@ importlib-metadata==6.11.0
     #   build
     #   keyring
     #   twine
-importlib-resources==6.4.0
-    # via
-    #   -r requirements/validation.txt
-    #   keyring
 inflection==0.5.1
     # via
     #   -r requirements/validation.txt
@@ -462,7 +453,7 @@ packaging==24.1
     #   pyproject-api
     #   pytest
     #   tox
-path==16.14.0
+path==17.0.0
     # via edx-i18n-tools
 pbr==6.0.0
     # via
@@ -601,7 +592,7 @@ pyyaml==6.0.1
     #   edx-i18n-tools
     #   responses
     #   xblock
-readme-renderer==43.0
+readme-renderer==44.0
     # via
     #   -r requirements/validation.txt
     #   twine
@@ -723,7 +714,6 @@ typing-extensions==4.12.2
     #   astroid
     #   edx-opaque-keys
     #   pylint
-    #   rich
 uritemplate==4.1.1
     # via
     #   -r requirements/validation.txt
@@ -769,7 +759,6 @@ zipp==3.19.2
     #   -r requirements/pip-tools.txt
     #   -r requirements/validation.txt
     #   importlib-metadata
-    #   importlib-resources
 
 # The following packages are considered to be unsafe in a requirements file:
 # pip

requirements/doc.in

@@ -4,7 +4,7 @@
 -r test.txt               # Core and testing dependencies for this package
 
 doc8                      # reStructuredText style checker
-edx_sphinx_theme          # edX theme for Sphinx output
+sphinx-book-theme        # edX theme for Sphinx output
 twine                     # Validates README.rst for usage on PyPI
 build                     # Needed to build the wheel for twine check
 Sphinx                    # Documentation builder

requirements/doc.txt

@@ -1,10 +1,12 @@
 #
-# This file is autogenerated by pip-compile with Python 3.8
+# This file is autogenerated by pip-compile with Python 3.9
 # by the following command:
 #
 #    make upgrade
 #
-alabaster==0.7.13
+accessible-pygments==0.0.5
+    # via pydata-sphinx-theme
+alabaster==0.7.16
     # via sphinx
 appdirs==1.4.4
     # via
@@ -30,14 +32,13 @@ attrs==23.2.0
     #   lti-consumer-xblock
     #   openedx-events
 babel==2.15.0
-    # via sphinx
+    # via
+    #   pydata-sphinx-theme
+    #   sphinx
 backports-tarfile==1.2.0
     # via jaraco-context
-backports-zoneinfo==0.2.1
-    # via
-    #   -r requirements/test.txt
-    #   django
-    #   djangorestframework
+beautifulsoup4==4.12.3
+    # via pydata-sphinx-theme
 bleach==6.1.0
     # via
     #   -r requirements/test.txt
@@ -213,9 +214,10 @@ dnspython==2.6.1
     #   pymongo
 doc8==1.1.1
     # via -r requirements/doc.in
-docutils==0.19
+docutils==0.20.1
     # via
     #   doc8
+    #   pydata-sphinx-theme
     #   readme-renderer
     #   restructuredtext-lint
     #   sphinx
@@ -265,8 +267,6 @@ edx-opaque-keys[django]==2.10.0
     #   openedx-events
 edx-rest-api-client==5.7.1
     # via -r requirements/test.txt
-edx-sphinx-theme==3.1.0
-    # via -r requirements/doc.in
 edx-toggles==5.2.0
     # via
     #   -r requirements/test.txt
@@ -322,8 +322,6 @@ importlib-metadata==6.11.0
     #   keyring
     #   sphinx
     #   twine
-importlib-resources==6.4.0
-    # via keyring
 inflection==0.5.1
     # via
     #   -r requirements/test.txt
@@ -435,6 +433,7 @@ packaging==24.1
     #   -r requirements/test.txt
     #   build
     #   drf-yasg
+    #   pydata-sphinx-theme
     #   pyproject-api
     #   pytest
     #   sphinx
@@ -469,9 +468,13 @@ pycryptodomex==3.20.0
     #   -r requirements/test.txt
     #   lti-consumer-xblock
     #   pyjwkest
+pydata-sphinx-theme==0.15.4
+    # via sphinx-book-theme
 pygments==2.18.0
     # via
+    #   accessible-pygments
     #   doc8
+    #   pydata-sphinx-theme
     #   readme-renderer
     #   rich
     #   sphinx
@@ -551,7 +554,6 @@ python3-openid==3.2.0
 pytz==2024.1
     # via
     #   -r requirements/test.txt
-    #   babel
     #   drf-yasg
     #   xblock
 pyyaml==6.0.1
@@ -617,7 +619,6 @@ six==1.16.0
     #   edx-ccx-keys
     #   edx-django-release-util
     #   edx-lint
-    #   edx-sphinx-theme
     #   fs
     #   fs-s3fs
     #   pyjwkest
@@ -637,21 +638,26 @@ social-auth-core==4.5.4
     #   -r requirements/test.txt
     #   edx-auth-backends
     #   social-auth-app-django
-sphinx==5.3.0
+soupsieve==2.5
+    # via beautifulsoup4
+sphinx==7.4.7
     # via
     #   -r requirements/doc.in
-    #   edx-sphinx-theme
-sphinxcontrib-applehelp==1.0.4
+    #   pydata-sphinx-theme
+    #   sphinx-book-theme
+sphinx-book-theme==1.1.3
+    # via -r requirements/doc.in
+sphinxcontrib-applehelp==2.0.0
     # via sphinx
-sphinxcontrib-devhelp==1.0.2
+sphinxcontrib-devhelp==2.0.0
     # via sphinx
-sphinxcontrib-htmlhelp==2.0.1
+sphinxcontrib-htmlhelp==2.1.0
     # via sphinx
 sphinxcontrib-jsmath==1.0.1
     # via sphinx
-sphinxcontrib-qthelp==1.0.3
+sphinxcontrib-qthelp==2.0.0
     # via sphinx
-sphinxcontrib-serializinghtml==1.1.5
+sphinxcontrib-serializinghtml==2.0.0
     # via sphinx
 sqlparse==0.5.1
     # via
@@ -677,6 +683,7 @@ tomli==2.0.1
     #   pylint
     #   pyproject-api
     #   pytest
+    #   sphinx
     #   tox
 tomlkit==0.13.0
     # via
@@ -692,8 +699,8 @@ typing-extensions==4.12.2
     #   asgiref
     #   astroid
     #   edx-opaque-keys
+    #   pydata-sphinx-theme
     #   pylint
-    #   rich
 uritemplate==4.1.1
     # via
     #   -r requirements/test.txt
@@ -731,9 +738,7 @@ xblock==5.0.0
     #   -r requirements/test.txt
     #   lti-consumer-xblock
 zipp==3.19.2
-    # via
-    #   importlib-metadata
-    #   importlib-resources
+    # via importlib-metadata
 
 # The following packages are considered to be unsafe in a requirements file:
 # setuptools

requirements/pip-tools.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.9
 # by the following command:
 #
 #    make upgrade

requirements/pip.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.9
 # by the following command:
 #
 #    make upgrade
@@ -8,7 +8,7 @@ wheel==0.43.0
     # via -r requirements/pip.in
 
 # The following packages are considered to be unsafe in a requirements file:
-pip==24.1.2
+pip==24.2
     # via -r requirements/pip.in
 setuptools==71.1.0
     # via -r requirements/pip.in

requirements/production.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.9
 # by the following command:
 #
 #    make upgrade
@@ -22,11 +22,6 @@ attrs==23.2.0
     #   -r requirements/base.txt
     #   lti-consumer-xblock
     #   openedx-events
-backports-zoneinfo==0.2.1
-    # via
-    #   -r requirements/base.txt
-    #   django
-    #   djangorestframework
 bleach==6.1.0
     # via
     #   -r requirements/base.txt