feat: Switch from edx-sphinx-theme to sphinx-book-theme

The edx-sphinx theme is being deprecated, and replaced with sphinx-book-theme. This removes references to the deprecated theme and replaces them with the new standard theme for the platform.
openedx · Mar 24, 2023 · 1560e7c · 1560e7c
1 parent d0c2491
commit 1560e7c
Show file tree

Hide file tree

Showing 9 changed files with 134 additions and 112 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -14,9 +14,10 @@
 import os
 import re
 import sys
+from datetime import datetime
 from subprocess import check_call
 
-import edx_theme
+
 
 import django
 from django.conf import settings
@@ -61,7 +62,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',
@@ -92,8 +92,8 @@ def get_version(*file_paths):
 
 # General information about the project.
 project = 'edx-ace'
-copyright = edx_theme.COPYRIGHT  # pylint: disable=redefined-builtin
-author = edx_theme.AUTHOR
+copyright = f'{datetime.now().year}, edX Inc.'  # pylint: disable=redefined-builtin
+author = 'edX Inc.'
 project_title = 'Automated Communication Engine'
 documentation_title = f"{project_title}"
 
@@ -164,16 +164,45 @@ 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/openedx/edx-ace",
+    "repository_branch": "master",
+    "path_to_docs": "docs/",
+    "home_page_in_toc": True,
+    "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"
+            >The Center for Reimagining Learning</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()]
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
@@ -187,13 +216,13 @@ def get_version(*file_paths):
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
 #
-# html_logo = None
+html_logo = "https://logos.openedx.org/open-edx-logo-color.png"
 
 # The name of an image file (relative to this directory) to use as a favicon of
 # the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
 #
-# html_favicon = None
+html_favicon = "https://logos.openedx.org/open-edx-favicon.ico"
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

diff --git a/requirements/ci.txt b/requirements/ci.txt
@@ -1,28 +1,28 @@
 #
-# This file is autogenerated by pip-compile with Python 3.8
+# This file is autogenerated by pip-compile with Python 3.10
 # by the following command:
 #
 #    make upgrade
 #
 certifi==2022.12.7
     # via requests
-charset-normalizer==3.0.1
+charset-normalizer==3.1.0
     # via requests
 codecov==2.1.12
     # via -r requirements/ci.in
-coverage==7.1.0
+coverage==7.2.2
     # via codecov
 distlib==0.3.6
     # via virtualenv
-filelock==3.9.0
+filelock==3.10.3
     # via
     #   tox
     #   virtualenv
 idna==3.4
     # via requests
 packaging==23.0
     # via tox
-platformdirs==3.0.0
+platformdirs==3.1.1
     # via virtualenv
 pluggy==1.0.0
     # via tox
@@ -41,7 +41,7 @@ tox==3.28.0
     #   tox-battery
 tox-battery==0.2
     # via -r requirements/ci.in
-urllib3==1.26.14
+urllib3==1.26.15
     # via requests
-virtualenv==20.19.0
+virtualenv==20.21.0
     # via tox
diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -1,12 +1,12 @@
 #
-# This file is autogenerated by pip-compile with Python 3.8
+# This file is autogenerated by pip-compile with Python 3.10
 # by the following command:
 #
 #    make upgrade
 #
 asgiref==3.6.0
     # via django
-astroid==2.14.2
+astroid==2.15.0
     # via
     #   pylint
     #   pylint-celery
@@ -22,7 +22,7 @@ cffi==1.15.1
     # via cryptography
 chardet==5.1.0
     # via diff-cover
-charset-normalizer==3.0.1
+charset-normalizer==3.1.0
     # via requests
 click==8.1.3
     # via
@@ -34,15 +34,15 @@ click-log==0.4.0
     # via edx-lint
 code-annotations==1.3.0
     # via edx-lint
-cryptography==39.0.1
+cryptography==40.0.0
     # via secretstorage
-diff-cover==7.4.0
+diff-cover==7.5.0
     # via -r requirements/dev.in
 dill==0.3.6
     # via pylint
 distlib==0.3.6
     # via virtualenv
-django==3.2.17
+django==3.2.18
     # via
     #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
     #   -r requirements/base.in
@@ -51,22 +51,20 @@ docutils==0.19
     # via readme-renderer
 edx-i18n-tools==0.9.2
     # via -r requirements/dev.in
-edx-lint==5.3.0
+edx-lint==5.3.4
     # via
     #   -r requirements/dev.in
     #   -r requirements/quality.in
-filelock==3.9.0
+filelock==3.10.3
     # via
     #   tox
     #   virtualenv
 idna==3.4
     # via requests
-importlib-metadata==6.0.0
+importlib-metadata==6.1.0
     # via
     #   keyring
     #   twine
-importlib-resources==5.10.2
-    # via keyring
 isort==5.12.0
     # via
     #   -r requirements/quality.in
@@ -85,15 +83,15 @@ keyring==23.13.1
     # via twine
 lazy-object-proxy==1.9.0
     # via astroid
-markdown-it-py==2.1.0
+markdown-it-py==2.2.0
     # via rich
 markupsafe==2.1.2
     # via jinja2
 mccabe==0.7.0
     # via pylint
 mdurl==0.1.2
     # via markdown-it-py
-more-itertools==9.0.0
+more-itertools==9.1.0
     # via jaraco-classes
 packaging==23.0
     # via
@@ -103,19 +101,19 @@ path==16.6.0
     # via edx-i18n-tools
 pbr==5.11.1
     # via stevedore
-pip-tools==6.12.2
+pip-tools==6.12.3
     # via -r requirements/dev.in
 pkginfo==1.9.6
     # via twine
-platformdirs==3.0.0
+platformdirs==3.1.1
     # via
     #   pylint
     #   virtualenv
 pluggy==1.0.0
     # via
     #   diff-cover
     #   tox
-polib==1.1.1
+polib==1.2.0
     # via edx-i18n-tools
 py==1.11.0
     # via tox
@@ -130,7 +128,7 @@ pygments==2.14.0
     #   diff-cover
     #   readme-renderer
     #   rich
-pylint==2.16.1
+pylint==2.17.1
     # via
     #   edx-lint
     #   pylint-celery
@@ -148,7 +146,7 @@ pyproject-hooks==1.0.0
     # via build
 python-dateutil==2.8.2
     # via -r requirements/base.in
-python-slugify==8.0.0
+python-slugify==8.0.1
     # via code-annotations
 pytz==2022.7.1
     # via django
@@ -167,13 +165,13 @@ requests-toolbelt==0.10.1
     # via twine
 rfc3986==2.0.0
     # via twine
-rich==13.3.1
+rich==13.3.2
     # via twine
 sailthru-client==2.2.3
     # via -r requirements/base.in
 secretstorage==3.3.3
     # via keyring
-simplejson==3.18.3
+simplejson==3.18.4
     # via sailthru-client
 six==1.16.0
     # via
@@ -206,29 +204,24 @@ tox==3.28.0
     #   -r requirements/dev.in
 twine==4.0.2
     # via -r requirements/dev.in
-typing-extensions==4.4.0
-    # via
-    #   astroid
-    #   pylint
-    #   rich
-urllib3==1.26.14
+typing-extensions==4.5.0
+    # via astroid
+urllib3==1.26.15
     # via
     #   requests
     #   twine
-virtualenv==20.19.0
+virtualenv==20.21.0
     # via tox
 webencodings==0.5.1
     # via bleach
-wheel==0.38.4
+wheel==0.40.0
     # via
     #   -r requirements/dev.in
     #   pip-tools
-wrapt==1.14.1
+wrapt==1.15.0
     # via astroid
-zipp==3.13.0
-    # via
-    #   importlib-metadata
-    #   importlib-resources
+zipp==3.15.0
+    # via importlib-metadata
 
 # The following packages are considered to be unsafe in a requirements file:
 # pip

diff --git a/requirements/doc.in b/requirements/doc.in
@@ -3,7 +3,7 @@
 -c constraints.txt
 
 doc8                      # reStructuredText style checker
-edx_sphinx_theme          # edX theme for Sphinx output
+sphinx-book-theme         # Common theme for all Open edX projects
 readme_renderer           # Validates README.rst for usage on PyPI
 Sphinx                    # Documentation builder
 twine