diff --git a/CHANGELOG.rst b/CHANGELOG.rst
index 144b3bf..08400d7 100644
--- a/CHANGELOG.rst
+++ b/CHANGELOG.rst
@@ -14,6 +14,9 @@ Change Log
Unreleased
~~~~~~~~~~
+[2.6.0]- 2024-11-06
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+* Deprecated edx-sphinx-theme and replaced it with sphinx-book-theme
[2.5.1] - 2024-02-22
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
diff --git a/docs/conf.py b/docs/conf.py
index 65558ba..e13aa2c 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -16,7 +16,8 @@
import sys
from subprocess import check_call
-import edx_theme
+import sphinx_book_theme
+from datetime import datetime
from django import setup as django_setup
@@ -59,7 +60,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 +91,8 @@ def get_version(*file_paths):
# General information about the project.
project = 'outcome_surveys'
-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 = 'outcome_surveys'
documentation_title = f"{project_title}"
@@ -162,16 +163,47 @@ 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 = {}
-# Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [edx_theme.get_html_theme_path()]
+html_theme_options = {
+
+ "repository_url": 'https://github.com/edx/outcome-surveys',
+ "repository_branch": 'master',
+ "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": """
+
+ 
+
+
+ These works by
+ edX LLC
+ are licensed under a
+ Creative Commons Attribution-ShareAlike 4.0 International License.
+ """
+}
+
+html_logo = "https://logos.openedx.org/open-edx-logo-color.png"
+html_favicon = "https://logos.openedx.org/open-edx-favicon.ico"
# The name for this set of Sphinx documents.
# " v documentation" by default.
diff --git a/outcome_surveys/__init__.py b/outcome_surveys/__init__.py
index f648998..68f0b33 100644
--- a/outcome_surveys/__init__.py
+++ b/outcome_surveys/__init__.py
@@ -2,6 +2,6 @@
Outcome Surveys.
"""
-__version__ = '2.5.1'
+__version__ = '2.6.0'
default_app_config = 'outcome_surveys.apps.OutcomeSurveysConfig' # pylint: disable=invalid-name
diff --git a/requirements/doc.in b/requirements/doc.in
index 68f4cb2..a30416e 100644
--- a/requirements/doc.in
+++ b/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
diff --git a/requirements/doc.txt b/requirements/doc.txt
index 4f64cfb..8fd2360 100644
--- a/requirements/doc.txt
+++ b/requirements/doc.txt
@@ -1,9 +1,11 @@
#
-# 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
+# pip-compile --output-file=requirements/doc.txt requirements/doc.in
#
+accessible-pygments==0.0.5
+ # via pydata-sphinx-theme
alabaster==0.7.13
# via sphinx
asgiref==3.7.2
@@ -15,7 +17,11 @@ asn1crypto==1.5.1
# -r requirements/test.txt
# snowflake-connector-python
babel==2.14.0
- # via sphinx
+ # via
+ # pydata-sphinx-theme
+ # sphinx
+beautifulsoup4==4.12.3
+ # via pydata-sphinx-theme
build==1.0.3
# via -r requirements/doc.in
certifi==2024.2.2
@@ -44,7 +50,6 @@ code-annotations==1.6.0
coverage[toml]==7.4.2
# via
# -r requirements/test.txt
- # coverage
# pytest-cov
cryptography==42.0.4
# via
@@ -54,7 +59,6 @@ cryptography==42.0.4
django==3.2.24
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
- # -r requirements/test.txt
# django-crum
# django-model-utils
# django-waffle
@@ -75,6 +79,7 @@ doc8==1.1.1
docutils==0.19
# via
# doc8
+ # pydata-sphinx-theme
# readme-renderer
# restructuredtext-lint
# sphinx
@@ -82,8 +87,6 @@ edx-django-utils==5.10.1
# via -r requirements/test.txt
edx-opaque-keys==2.5.1
# via -r requirements/test.txt
-edx-sphinx-theme==3.1.0
- # via -r requirements/doc.in
exceptiongroup==1.2.0
# via
# -r requirements/test.txt
@@ -99,14 +102,13 @@ idna==3.6
# snowflake-connector-python
imagesize==1.4.1
# via sphinx
-importlib-metadata==7.0.1
+importlib-metadata==6.11.0
# via
+ # -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# build
# keyring
# sphinx
# twine
-importlib-resources==6.1.1
- # via keyring
iniconfig==2.0.0
# via
# -r requirements/test.txt
@@ -142,6 +144,7 @@ packaging==23.2
# via
# -r requirements/test.txt
# build
+ # pydata-sphinx-theme
# pytest
# snowflake-connector-python
# sphinx
@@ -168,9 +171,13 @@ pycparser==2.21
# via
# -r requirements/test.txt
# cffi
+pydata-sphinx-theme==0.15.4
+ # via sphinx-book-theme
pygments==2.17.2
# via
+ # accessible-pygments
# doc8
+ # pydata-sphinx-theme
# readme-renderer
# rich
# sphinx
@@ -208,7 +215,6 @@ python-slugify==8.0.4
pytz==2024.1
# via
# -r requirements/test.txt
- # babel
# django
# snowflake-connector-python
pyyaml==6.0.1
@@ -232,8 +238,6 @@ rfc3986==2.0.0
# via twine
rich==13.7.0
# via twine
-six==1.16.0
- # via edx-sphinx-theme
snowballstemmer==2.2.0
# via sphinx
snowflake-connector-python==3.7.1
@@ -242,10 +246,15 @@ sortedcontainers==2.4.0
# via
# -r requirements/test.txt
# snowflake-connector-python
+soupsieve==2.5
+ # via beautifulsoup4
sphinx==5.3.0
# via
# -r requirements/doc.in
- # edx-sphinx-theme
+ # pydata-sphinx-theme
+ # sphinx-book-theme
+sphinx-book-theme==1.1.3
+ # via -r requirements/doc.in
sphinxcontrib-applehelp==1.0.4
# via sphinx
sphinxcontrib-devhelp==1.0.2
@@ -292,7 +301,7 @@ typing-extensions==4.9.0
# -r requirements/test.txt
# asgiref
# edx-opaque-keys
- # rich
+ # pydata-sphinx-theme
# snowflake-connector-python
urllib3==1.26.18
# via
@@ -301,6 +310,4 @@ urllib3==1.26.18
# snowflake-connector-python
# twine
zipp==3.17.0
- # via
- # importlib-metadata
- # importlib-resources
+ # via importlib-metadata