Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: deprecate edx-sphinx-theme #297

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 6 additions & 8 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,9 @@
import re
import sys
from subprocess import check_call
import datetime

import edx_theme
import sphinx_book_theme


def get_version(*file_paths):
Expand Down Expand Up @@ -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',
Expand Down Expand Up @@ -90,8 +91,8 @@ def get_version(*file_paths):

# General information about the project.
project = 'edx_exams'
copyright = edx_theme.COPYRIGHT # pylint: disable=redefined-builtin
author = edx_theme.AUTHOR
copyright = '{year}, edX Inc.'.format(year=datetime.datetime.now().year) # pylint: disable=redefined-builtin
author = 'edx-org'
project_title = 'edx_exams'
documentation_title = f"{project_title}"

Expand Down Expand Up @@ -172,17 +173,14 @@ 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()]

# The name for this set of Sphinx documents.
# "<project> v<release> documentation" by default.
#
Expand Down
2 changes: 1 addition & 1 deletion requirements/doc.in
Original file line number Diff line number Diff line change
Expand Up @@ -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 # sphinx book theme
twine # Validates README.rst for usage on PyPI
build # Needed to build the wheel for twine check
Sphinx # Documentation builder
25 changes: 20 additions & 5 deletions requirements/doc.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
#
# make upgrade
#
accessible-pygments==0.0.5
# via pydata-sphinx-theme
alabaster==0.7.16
# via sphinx
appdirs==1.4.4
Expand Down Expand Up @@ -31,6 +33,11 @@ attrs==24.2.0
# openedx-events
babel==2.16.0
# via sphinx
backports-tarfile==1.2.0
# via jaraco-context
beautifulsoup4==4.12.3
# via pydata-sphinx-theme

backports-tarfile==1.2.0
# via jaraco-context
bleach==6.1.0
Expand Down Expand Up @@ -125,7 +132,6 @@ distlib==0.3.8
django==4.2.15
# via
# -c requirements/common_constraints.txt
# -r requirements/test.txt
# django-appconf
# django-config-models
# django-cors-headers
Expand Down Expand Up @@ -211,6 +217,7 @@ doc8==1.1.1
docutils==0.19
# via
# doc8
# pydata-sphinx-theme
# readme-renderer
# restructuredtext-lint
# sphinx
Expand Down Expand Up @@ -260,8 +267,6 @@ edx-opaque-keys[django]==2.10.0
# openedx-events
edx-rest-api-client==5.7.1
# via -r requirements/test.txt
edx-sphinx-theme==3.1.0
# via -r requirements/doc.in
edx-toggles==5.2.0
# via
# -r requirements/test.txt
Expand Down Expand Up @@ -427,6 +432,7 @@ packaging==24.1
# -r requirements/test.txt
# build
# drf-yasg
# pydata-sphinx-theme
# pyproject-api
# pytest
# sphinx
Expand Down Expand Up @@ -461,9 +467,13 @@ pycryptodomex==3.20.0
# -r requirements/test.txt
# lti-consumer-xblock
# pyjwkest
pydata-sphinx-theme==0.15.4
# via sphinx-book-theme
pygments==2.18.0
# via
# accessible-pygments
# doc8
# pydata-sphinx-theme
# readme-renderer
# rich
# sphinx
Expand Down Expand Up @@ -608,7 +618,6 @@ six==1.16.0
# edx-ccx-keys
# edx-django-release-util
# edx-lint
# edx-sphinx-theme
# fs
# fs-s3fs
# pyjwkest
Expand All @@ -628,10 +637,15 @@ social-auth-core==4.5.4
# -r requirements/test.txt
# edx-auth-backends
# social-auth-app-django
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
Expand Down Expand Up @@ -683,6 +697,7 @@ typing-extensions==4.12.2
# asgiref
# astroid
# edx-opaque-keys
# pydata-sphinx-theme
# pylint
uritemplate==4.1.1
# via
Expand Down
Loading