diff --git a/.gitignore b/.gitignore
index f3bb038..1d1af86 100644
--- a/.gitignore
+++ b/.gitignore
@@ -31,6 +31,7 @@ pip-log.txt
.tox
coverage.xml
htmlcov/
+venv
diff --git a/docs/conf.py b/docs/conf.py
index ea24499..bbe548b 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -15,8 +15,8 @@
import re
import sys
from subprocess import check_call
-
-import edx_theme
+from datetime import datetime
+import sphinx_book_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 = 'braze-client'
-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 = 'braze-client'
documentation_title = f"{project_title}"
@@ -172,16 +172,49 @@ 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/braze-client',
+ "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": """
+
+ 
+
+
+ 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"
+
+if not os.environ.get('DJANGO_SETTINGS_MODULE'):
+ os.environ['DJANGO_SETTINGS_MODULE'] = 'test_utils.test_settings'
# The name for this set of Sphinx documents.
# " v documentation" by default.
diff --git a/requirements/dev.txt b/requirements/dev.txt
index 656a8ff..056b993 100644
--- a/requirements/dev.txt
+++ b/requirements/dev.txt
@@ -206,7 +206,7 @@ python-slugify==5.0.2
# via
# -r requirements/quality.txt
# code-annotations
-pyyaml==6.0
+pyyaml==6.0.1
# via
# -r requirements/quality.txt
# code-annotations
diff --git a/requirements/doc.in b/requirements/doc.in
index 690e8e1..9f6e84a 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 # edX theme for Sphinx output
readme_renderer # Validates README.rst for usage on PyPI
Sphinx # Documentation builder
diff --git a/requirements/doc.txt b/requirements/doc.txt
index 642b33d..8ddad4b 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
attrs==21.2.0
@@ -11,7 +13,11 @@ attrs==21.2.0
# -r requirements/test.txt
# pytest
babel==2.9.1
- # via sphinx
+ # via
+ # pydata-sphinx-theme
+ # sphinx
+beautifulsoup4==4.12.3
+ # via pydata-sphinx-theme
bleach==4.1.0
# via readme-renderer
certifi==2021.10.8
@@ -30,20 +36,23 @@ ddt==1.4.4
# via -r requirements/test.txt
doc8==0.9.1
# via -r requirements/doc.in
-docutils==0.17.1
+docutils==0.19
# 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
# -r requirements/test.txt
# requests
-imagesize==1.2.0
+imagesize==1.4.1
# via sphinx
+importlib-metadata==6.11.0
+ # via
+ # -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
+ # sphinx
iniconfig==1.1.1
# via
# -r requirements/test.txt
@@ -56,6 +65,7 @@ packaging==21.0
# via
# -r requirements/test.txt
# bleach
+ # pydata-sphinx-theme
# pytest
# sphinx
pbr==5.6.0
@@ -68,9 +78,13 @@ py==1.10.0
# via
# -r requirements/test.txt
# pytest
-pygments==2.10.0
+pydata-sphinx-theme==0.14.4
+ # via sphinx-book-theme
+pygments==2.18.0
# via
+ # accessible-pygments
# doc8
+ # pydata-sphinx-theme
# readme-renderer
# sphinx
pyparsing==2.4.7
@@ -100,14 +114,18 @@ six==1.16.0
# via
# -r requirements/test.txt
# bleach
- # edx-sphinx-theme
# responses
snowballstemmer==2.1.0
# via sphinx
-sphinx==4.2.0
+soupsieve==2.5
+ # via beautifulsoup4
+sphinx==6.2.1
# via
# -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
@@ -130,6 +148,8 @@ tomli==1.2.1
# via
# -r requirements/test.txt
# coverage
+typing-extensions==4.12.2
+ # via pydata-sphinx-theme
urllib3==1.26.7
# via
# -r requirements/test.txt
@@ -137,6 +157,5 @@ urllib3==1.26.7
# responses
webencodings==0.5.1
# via bleach
-
-# The following packages are considered to be unsafe in a requirements file:
-# setuptools
+zipp==3.19.2
+ # via importlib-metadata
diff --git a/requirements/quality.txt b/requirements/quality.txt
index 22deffc..a8396af 100644
--- a/requirements/quality.txt
+++ b/requirements/quality.txt
@@ -120,7 +120,7 @@ pytest-cov==3.0.0
# via -r requirements/test.txt
python-slugify==5.0.2
# via code-annotations
-pyyaml==6.0
+pyyaml==6.0.1
# via code-annotations
readme-renderer==30.0
# via twine