diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index 4cb1048..ec7c625 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -14,6 +14,9 @@ Change Log
Unreleased
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+* Switch from ``edx-sphinx-theme`` to ``sphinx-book-theme`` since the former is
+ deprecated
+
[1.4.0] - 2022-05-23
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/conf.py b/docs/conf.py
index 991f2d8..c78985b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -17,9 +17,10 @@
import os
import re
import sys
+from datetime import datetime
from subprocess import check_call
-import edx_theme
+
def get_version(*file_paths):
@@ -57,7 +58,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',
@@ -88,8 +88,8 @@ def get_version(*file_paths):
# General information about the project.
project = 'code-annotations'
-copyright = edx_theme.COPYRIGHT # pylint: disable=redefined-builtin
-author = edx_theme.AUTHOR
+copyright = f'{datetime.now().year}, The Axim Collaborative' # pylint: disable=redefined-builtin
+author = 'The Axim Collaborative'
project_title = 'Code Annotations'
documentation_title = f"{project_title}"
@@ -160,16 +160,46 @@ 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/code-annotations",
+ "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": """
+
+ 
+
+
+ These works by
+ The Axim Collaborative
+ are licensed under a
+ Creative Commons Attribution-ShareAlike 4.0 International License.
+ """
+}
# 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.
# " v documentation" by default.
@@ -183,13 +213,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/doc.in b/requirements/doc.in
index 8e0f020..0a7d1fe 100644
--- a/requirements/doc.in
+++ b/requirements/doc.in
@@ -4,6 +4,6 @@
-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 # Common theme for all Open edX projects
Sphinx # Documentation builder
twine # Validates README.rst for usage on PyPI
diff --git a/requirements/doc.txt b/requirements/doc.txt
index 3ecbbd0..f927d40 100644
--- 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
asgiref==3.5.2
@@ -15,7 +17,11 @@ attrs==21.4.0
# -r requirements/test.txt
# 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
@@ -43,11 +49,10 @@ doc8==0.11.2
docutils==0.18.1
# via
# doc8
+ # pydata-sphinx-theme
# readme-renderer
# restructuredtext-lint
# sphinx
-edx-sphinx-theme==3.0.0
- # via -r requirements/doc.in
idna==3.3
# via requests
imagesize==1.3.0
@@ -80,6 +85,7 @@ mock==4.0.3
packaging==21.3
# via
# -r requirements/test.txt
+ # pydata-sphinx-theme
# pytest
# sphinx
pbr==5.9.0
@@ -98,9 +104,13 @@ py==1.11.0
# pytest
pycparser==2.21
# via cffi
+pydata-sphinx-theme==0.13.3
+ # via sphinx-book-theme
pygments==2.12.0
# via
+ # accessible-pygments
# doc8
+ # pydata-sphinx-theme
# readme-renderer
# rich
# sphinx
@@ -141,16 +151,19 @@ rich==12.4.4
secretstorage==3.3.3
# via keyring
six==1.16.0
- # via
- # bleach
- # edx-sphinx-theme
+ # via bleach
snowballstemmer==2.2.0
# via sphinx
+soupsieve==2.4.1
+ # via beautifulsoup4
sphinx==5.0.2
# 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
@@ -183,7 +196,9 @@ tomli==2.0.1
twine==4.0.1
# via -r requirements/doc.in
typing-extensions==4.2.0
- # via rich
+ # via
+ # pydata-sphinx-theme
+ # rich
urllib3==1.26.9
# via
# requests