diff --git a/.gitignore b/.gitignore
index 93e7105..0809a02 100644
--- a/.gitignore
+++ b/.gitignore
@@ -8,3 +8,5 @@ build/
.coverage
dist/
/pii_report/*.yaml
+docs/_build
+venv
diff --git a/docs/conf.py b/docs/conf.py
index fd05e10..f8df7c3 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
from django import setup as django_setup
@@ -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 = 'edx-arch-experiments'
-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 = 'edx-arch-experiments'
documentation_title = f"{project_title}"
@@ -162,16 +162,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/edx-arch-experiments",
+ "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
+ Axim Collaborative
+ 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/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 5eac2f6..d237831 100644
--- a/requirements/doc.txt
+++ b/requirements/doc.txt
@@ -1,9 +1,11 @@
#
-# This file is autogenerated by pip-compile with Python 3.11
+# 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.16
# via sphinx
asgiref==3.8.1
@@ -18,7 +20,11 @@ attrs==23.2.0
# jsonschema
# referencing
babel==2.15.0
- # via sphinx
+ # via
+ # pydata-sphinx-theme
+ # sphinx
+beautifulsoup4==4.12.3
+ # via pydata-sphinx-theme
bytecode==0.15.1
# via
# -r requirements/test.txt
@@ -72,7 +78,6 @@ deprecated==1.2.14
django==4.2.14
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
- # -r requirements/test.txt
# django-crum
# django-waffle
# djangorestframework
@@ -105,6 +110,7 @@ doc8==1.1.1
docutils==0.19
# via
# doc8
+ # pydata-sphinx-theme
# readme-renderer
# restructuredtext-lint
# sphinx
@@ -125,14 +131,16 @@ edx-opaque-keys==2.10.0
# via
# -r requirements/test.txt
# edx-drf-extensions
-edx-sphinx-theme==3.1.0
- # via -r requirements/doc.in
edx-toggles==5.2.0
# via -r requirements/test.txt
envier==0.5.2
# via
# -r requirements/test.txt
# ddtrace
+exceptiongroup==1.2.2
+ # via
+ # cattrs
+ # pytest
idna==3.7
# via
# -r requirements/test.txt
@@ -144,6 +152,7 @@ importlib-metadata==6.11.0
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/test.txt
# opentelemetry-api
+ # sphinx
iniconfig==2.0.0
# via
# -r requirements/test.txt
@@ -176,6 +185,7 @@ opentelemetry-api==1.26.0
packaging==24.1
# via
# -r requirements/test.txt
+ # pydata-sphinx-theme
# pytest
# sphinx
pbr==6.0.0
@@ -198,9 +208,13 @@ pycparser==2.22
# via
# -r requirements/test.txt
# cffi
+pydata-sphinx-theme==0.15.4
+ # via sphinx-book-theme
pygments==2.18.0
# via
+ # accessible-pygments
# doc8
+ # pydata-sphinx-theme
# readme-renderer
# sphinx
pyjwt[crypto]==2.9.0
@@ -262,13 +276,17 @@ six==1.16.0
# ddsketch
# ddtrace
# edx-codejail
- # edx-sphinx-theme
snowballstemmer==2.2.0
# via sphinx
+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==2.0.0
# via sphinx
sphinxcontrib-devhelp==2.0.0
@@ -296,11 +314,20 @@ text-unidecode==1.3
# via
# -r requirements/test.txt
# python-slugify
+tomli==2.0.1
+ # via
+ # coverage
+ # doc8
+ # pytest
typing-extensions==4.12.2
# via
# -r requirements/test.txt
+ # asgiref
+ # bytecode
+ # cattrs
# ddtrace
# edx-opaque-keys
+ # pydata-sphinx-theme
urllib3==2.2.2
# via
# -r requirements/test.txt
@@ -319,5 +346,4 @@ zipp==3.19.2
# importlib-metadata
# The following packages are considered to be unsafe in a requirements file:
-setuptools==72.1.0
- # via -r requirements/test.txt
+# setuptools