chore: 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, replaces them with the new standard theme for the platform, and updates the theme configuraiton to use the new theme. See openedx/edx-sphinx-theme#184
open-craft · May 19, 2023 · 3025e36 · 3025e36
1 parent 7f5da69
commit 3025e36
Show file tree

Hide file tree

Showing 6 changed files with 88 additions and 18 deletions.
diff --git a/docs/conf.py b/docs/conf.py
@@ -13,6 +13,7 @@
 
 import sys
 import os
+from datetime import datetime
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -46,7 +47,7 @@
 
 # General information about the project.
 project = 'opaque_keys'
-copyright = '2014, Author'
+copyright = f'{datetime.now().year}, Axim Collaborative, Inc' # pylint: disable=redefined-builtin
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -100,12 +101,42 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+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/opaque-keys",
+    "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"
+            >Axim Collaborative, Inc</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 = []
@@ -119,12 +150,12 @@
 
 # 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 (within the static path) to use as 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
@@ -42,6 +42,7 @@ toml==0.10.2
     # via tox
 tox==3.25.1
     # via
+    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
     #   -r requirements/ci.in
     #   tox-battery
 tox-battery==0.6.1

diff --git a/requirements/dev.txt b/requirements/dev.txt
@@ -4,6 +4,10 @@
 #
 #    make upgrade
 #
+accessible-pygments==0.0.4
+    # via
+    #   -r requirements/doc.txt
+    #   pydata-sphinx-theme
 alabaster==0.7.12
     # via
     #   -r requirements/doc.txt
@@ -21,7 +25,12 @@ attrs==22.1.0
 babel==2.10.3
     # via
     #   -r requirements/doc.txt
+    #   pydata-sphinx-theme
     #   sphinx
+beautifulsoup4==4.12.2
+    # via
+    #   -r requirements/doc.txt
+    #   pydata-sphinx-theme
 bleach==5.0.1
     # via
     #   -r requirements/doc.txt
@@ -81,12 +90,11 @@ docopt==0.6.2
 docutils==0.19
     # via
     #   -r requirements/doc.txt
+    #   pydata-sphinx-theme
     #   readme-renderer
     #   sphinx
 edx-lint==5.2.4
     # via -r requirements/doc.txt
-edx-sphinx-theme==3.0.0
-    # via -r requirements/doc.txt
 exceptiongroup==1.0.0rc8
     # via
     #   -r requirements/doc.txt
@@ -149,6 +157,7 @@ packaging==21.3
     #   -r requirements/doc.txt
     #   -r requirements/pip-tools.txt
     #   build
+    #   pydata-sphinx-theme
     #   pytest
     #   sphinx
     #   tox
@@ -188,9 +197,15 @@ py==1.11.0
     #   tox
 pycodestyle==2.9.1
     # via -r requirements/doc.txt
+pydata-sphinx-theme==0.13.3
+    # via
+    #   -r requirements/doc.txt
+    #   sphinx-book-theme
 pygments==2.13.0
     # via
     #   -r requirements/doc.txt
+    #   accessible-pygments
+    #   pydata-sphinx-theme
     #   readme-renderer
     #   sphinx
 pylint==2.14.5
@@ -276,7 +291,6 @@ six==1.16.0
     #   -r requirements/doc.txt
     #   bleach
     #   edx-lint
-    #   edx-sphinx-theme
     #   pytest-xdist
     #   tox
 snowballstemmer==2.2.0
@@ -287,10 +301,18 @@ sortedcontainers==2.4.0
     # via
     #   -r requirements/doc.txt
     #   hypothesis
+soupsieve==2.4.1
+    # via
+    #   -r requirements/doc.txt
+    #   beautifulsoup4
 sphinx==5.1.1
     # via
+    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
     #   -r requirements/doc.txt
-    #   edx-sphinx-theme
+    #   pydata-sphinx-theme
+    #   sphinx-book-theme
+sphinx-book-theme==1.0.1
+    # via -r requirements/doc.txt
 sphinxcontrib-applehelp==1.0.2
     # via
     #   -r requirements/doc.txt
@@ -343,6 +365,7 @@ tomlkit==0.11.4
     #   pylint
 tox==3.25.1
     # via
+    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
     #   -r requirements/ci.txt
     #   tox-battery
 tox-battery==0.6.1
@@ -351,6 +374,7 @@ typing-extensions==4.3.0
     # via
     #   -r requirements/doc.txt
     #   astroid
+    #   pydata-sphinx-theme
     #   pylint
 urllib3==1.26.12
     # via

diff --git a/requirements/doc.in b/requirements/doc.in
@@ -3,6 +3,6 @@
 
 -r test.txt               # Core and testing dependencies for this package
 
-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
diff --git a/requirements/doc.txt b/requirements/doc.txt
@@ -4,6 +4,8 @@
 #
 #    make upgrade
 #
+accessible-pygments==0.0.4
+    # via pydata-sphinx-theme
 alabaster==0.7.12
     # via sphinx
 astroid==2.11.7
@@ -17,7 +19,11 @@ attrs==22.1.0
     #   hypothesis
     #   pytest
 babel==2.10.3
-    # via sphinx
+    # via
+    #   pydata-sphinx-theme
+    #   sphinx
+beautifulsoup4==4.12.2
+    # via pydata-sphinx-theme
 bleach==5.0.1
     # via readme-renderer
 certifi==2022.6.15
@@ -50,12 +56,11 @@ dill==0.3.5.1
     #   pylint
 docutils==0.19
     # via
+    #   pydata-sphinx-theme
     #   readme-renderer
     #   sphinx
 edx-lint==5.2.4
     # via -r requirements/test.txt
-edx-sphinx-theme==3.0.0
-    # via -r requirements/doc.in
 exceptiongroup==1.0.0rc8
     # via
     #   -r requirements/test.txt
@@ -103,6 +108,7 @@ more-itertools==8.14.0
 packaging==21.3
     # via
     #   -r requirements/test.txt
+    #   pydata-sphinx-theme
     #   pytest
     #   sphinx
 pbr==5.10.0
@@ -129,8 +135,12 @@ py==1.11.0
     #   pytest-forked
 pycodestyle==2.9.1
     # via -r requirements/test.txt
+pydata-sphinx-theme==0.13.3
+    # via sphinx-book-theme
 pygments==2.13.0
     # via
+    #   accessible-pygments
+    #   pydata-sphinx-theme
     #   readme-renderer
     #   sphinx
 pylint==2.14.5
@@ -207,18 +217,23 @@ six==1.16.0
     #   -r requirements/test.txt
     #   bleach
     #   edx-lint
-    #   edx-sphinx-theme
     #   pytest-xdist
 snowballstemmer==2.2.0
     # via sphinx
 sortedcontainers==2.4.0
     # via
     #   -r requirements/test.txt
     #   hypothesis
+soupsieve==2.4.1
+    # via beautifulsoup4
 sphinx==5.1.1
     # via
+    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
     #   -r requirements/doc.in
-    #   edx-sphinx-theme
+    #   pydata-sphinx-theme
+    #   sphinx-book-theme
+sphinx-book-theme==1.0.1
+    # via -r requirements/doc.in
 sphinxcontrib-applehelp==1.0.2
     # via sphinx
 sphinxcontrib-devhelp==1.0.2
@@ -256,6 +271,7 @@ typing-extensions==4.3.0
     # via
     #   -r requirements/test.txt
     #   astroid
+    #   pydata-sphinx-theme
     #   pylint
 urllib3==1.26.12
     # via requests

diff --git a/requirements/pip.txt b/requirements/pip.txt
@@ -11,6 +11,4 @@ wheel==0.37.1
 pip==22.2.2
     # via -r requirements/pip.in
 setuptools==59.8.0
-    # via
-    #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
-    #   -r requirements/pip.in
+    # via -r requirements/pip.in