Skip to content

Commit

Permalink
chore: Switch from edx-sphinx-theme to sphinx-book-theme
Browse files Browse the repository at this point in the history
The edx-sphinx theme is being deprecated, and replaced with sphinx-book-theme.
This removes references to the deprecated theme and replaces them with the new
standard theme for the platform.

See openedx/edx-sphinx-theme#184
  • Loading branch information
xitij2000 committed May 25, 2023
1 parent b51eeb1 commit 9477825
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 26 deletions.
5 changes: 0 additions & 5 deletions requirements/common_constraints.txt
Expand Up @@ -30,8 +30,3 @@ tox<4.0.0
# Pinning Sphinx version unless the compatibility issue gets resolved
# For details, see issue https://github.com/openedx/edx-sphinx-theme/issues/197
sphinx<6.0.0

# 2023-05-18: edx-drf-extensions 8.8.0 inadvertently introduced stricter Base64 decoding,
# and some of our IDAs have malformed configs. This should be a very temporary constraint.
# See https://github.com/openedx/edx-drf-extensions/issues/346 for details.
edx-drf-extensions<8.8.0
2 changes: 1 addition & 1 deletion requirements/docs.in
@@ -1,4 +1,4 @@
-c constraints.txt

Sphinx
edx-sphinx-theme
sphinx-book-theme
36 changes: 27 additions & 9 deletions requirements/docs.txt
Expand Up @@ -4,18 +4,24 @@
#
# make upgrade
#
accessible-pygments==0.0.4
# via pydata-sphinx-theme
alabaster==0.7.13
# via sphinx
babel==2.12.1
# via sphinx
# via
# pydata-sphinx-theme
# sphinx
beautifulsoup4==4.12.2
# via pydata-sphinx-theme
certifi==2023.5.7
# via requests
charset-normalizer==3.1.0
# via requests
docutils==0.19
# via sphinx
edx-sphinx-theme==3.1.0
# via -r requirements/docs.in
# via
# pydata-sphinx-theme
# sphinx
idna==3.4
# via requests
imagesize==1.4.1
Expand All @@ -27,22 +33,32 @@ jinja2==3.1.2
markupsafe==2.1.2
# via jinja2
packaging==23.1
# via sphinx
# via
# pydata-sphinx-theme
# sphinx
pydata-sphinx-theme==0.13.3
# via sphinx-book-theme
pygments==2.15.1
# via sphinx
# via
# accessible-pygments
# pydata-sphinx-theme
# sphinx
pytz==2023.3
# via babel
requests==2.30.0
# via sphinx
six==1.16.0
# via edx-sphinx-theme
snowballstemmer==2.2.0
# via sphinx
soupsieve==2.4.1
# via beautifulsoup4
sphinx==5.3.0
# via
# -c requirements/common_constraints.txt
# -r requirements/docs.in
# edx-sphinx-theme
# pydata-sphinx-theme
# sphinx-book-theme
sphinx-book-theme==1.0.1
# via -r requirements/docs.in
sphinxcontrib-applehelp==1.0.4
# via sphinx
sphinxcontrib-devhelp==1.0.2
Expand All @@ -55,6 +71,8 @@ sphinxcontrib-qthelp==1.0.3
# via sphinx
sphinxcontrib-serializinghtml==1.1.5
# via sphinx
typing-extensions==4.6.2
# via pydata-sphinx-theme
urllib3==1.26.15
# via
# -c requirements/constraints.txt
Expand Down
38 changes: 30 additions & 8 deletions requirements/local.txt
Expand Up @@ -4,6 +4,10 @@
#
# make upgrade
#
accessible-pygments==0.0.4
# via
# -r requirements/docs.txt
# pydata-sphinx-theme
alabaster==0.7.13
# via
# -r requirements/docs.txt
Expand All @@ -22,7 +26,12 @@ attrs==23.1.0
babel==2.12.1
# via
# -r requirements/docs.txt
# pydata-sphinx-theme
# sphinx
beautifulsoup4==4.12.2
# via
# -r requirements/docs.txt
# pydata-sphinx-theme
certifi==2023.5.7
# via
# -r requirements/docs.txt
Expand Down Expand Up @@ -66,7 +75,7 @@ coreschema==0.0.4
# -r requirements/test.txt
# coreapi
# drf-yasg
coverage[toml]==7.2.5
coverage[toml]==7.2.6
# via
# -r requirements/test.txt
# pytest-cov
Expand Down Expand Up @@ -129,6 +138,7 @@ djangorestframework==3.14.0
docutils==0.19
# via
# -r requirements/docs.txt
# pydata-sphinx-theme
# sphinx
drf-nested-routers==0.93.4
# via -r requirements/test.txt
Expand All @@ -146,8 +156,6 @@ edx-django-utils==5.4.0
# via -r requirements/test.txt
edx-lint==5.3.4
# via -r requirements/test.txt
edx-sphinx-theme==3.1.0
# via -r requirements/docs.txt
exceptiongroup==1.1.1
# via
# -r requirements/test.txt
Expand Down Expand Up @@ -230,6 +238,7 @@ packaging==23.1
# -r requirements/docs.txt
# -r requirements/test.txt
# drf-yasg
# pydata-sphinx-theme
# pytest
# sphinx
pbr==5.11.1
Expand All @@ -255,11 +264,17 @@ pycparser==2.21
# via
# -r requirements/test.txt
# cffi
pydata-sphinx-theme==0.13.3
# via
# -r requirements/docs.txt
# sphinx-book-theme
pygments==2.15.1
# via
# -r requirements/docs.txt
# -r requirements/test.txt
# accessible-pygments
# diff-cover
# pydata-sphinx-theme
# sphinx
pyjwt[crypto]==2.7.0
# via
Expand Down Expand Up @@ -295,7 +310,7 @@ pytest==7.3.1
# -r requirements/test.txt
# pytest-cov
# pytest-django
pytest-cov==4.0.0
pytest-cov==4.1.0
# via -r requirements/test.txt
pytest-django==4.5.2
# via -r requirements/test.txt
Expand Down Expand Up @@ -346,13 +361,11 @@ ruamel-yaml-clib==0.2.7
# ruamel-yaml
six==1.16.0
# via
# -r requirements/docs.txt
# -r requirements/test.txt
# django-dynamic-fixture
# edx-auth-backends
# edx-django-release-util
# edx-lint
# edx-sphinx-theme
# python-dateutil
snowballstemmer==2.2.0
# via
Expand All @@ -367,11 +380,18 @@ social-auth-core==4.4.2
# -r requirements/test.txt
# edx-auth-backends
# social-auth-app-django
soupsieve==2.4.1
# via
# -r requirements/docs.txt
# beautifulsoup4
sphinx==5.3.0
# via
# -c requirements/common_constraints.txt
# -r requirements/docs.txt
# edx-sphinx-theme
# pydata-sphinx-theme
# sphinx-book-theme
sphinx-book-theme==1.0.1
# via -r requirements/docs.txt
sphinxcontrib-applehelp==1.0.4
# via
# -r requirements/docs.txt
Expand Down Expand Up @@ -421,11 +441,13 @@ tomlkit==0.11.8
# via
# -r requirements/test.txt
# pylint
typing-extensions==4.5.0
typing-extensions==4.6.2
# via
# -r requirements/docs.txt
# -r requirements/test.txt
# astroid
# mypy
# pydata-sphinx-theme
# pylint
uritemplate==4.1.1
# via
Expand Down
6 changes: 3 additions & 3 deletions requirements/test.txt
Expand Up @@ -50,7 +50,7 @@ coreschema==0.0.4
# -r requirements/base.txt
# coreapi
# drf-yasg
coverage[toml]==7.2.5
coverage[toml]==7.2.6
# via
# -r requirements/test.in
# pytest-cov
Expand Down Expand Up @@ -227,7 +227,7 @@ pytest==7.3.1
# -r requirements/test.in
# pytest-cov
# pytest-django
pytest-cov==4.0.0
pytest-cov==4.1.0
# via -r requirements/test.in
pytest-django==4.5.2
# via -r requirements/test.in
Expand Down Expand Up @@ -304,7 +304,7 @@ tomli==2.0.1
# pytest
tomlkit==0.11.8
# via pylint
typing-extensions==4.5.0
typing-extensions==4.6.2
# via
# astroid
# mypy
Expand Down

0 comments on commit 9477825

Please sign in to comment.