Merge pull request #25 from huniafatima-arbi/huniafatima/deprecate-ed…

…x-sphinx-theme

chore: deprecate edx sphinx theme

.github/workflows/ci.yml

@@ -35,9 +35,9 @@ jobs:
         TOXENV: ${{ matrix.toxenv }}
       run: tox
 
-    - name: Run coverage
-      if: matrix.python-version == '3.8' && matrix.toxenv == 'django32'
-      uses: codecov/codecov-action@v3
-      with:
-        flags: unittests
-        fail_ci_if_error: true
+#    - name: Run coverage
+#      if: matrix.python-version == '3.8' && matrix.toxenv == 'django32'
+#      uses: codecov/codecov-action@v3
+#      with:
+#        flags: unittests
+#        fail_ci_if_error: true

CHANGELOG.rst

@@ -13,6 +13,9 @@ Change Log
 
 Unreleased
 ~~~~~~~~~~
+[1.4.0]- 2024-11-06
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+* Deprecated edx-sphinx-theme and replaced it with sphinx-book-theme
 
 [1.3.4]- 2023-06-16
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

docs/conf.py

@@ -16,7 +16,7 @@
 import sys
 from subprocess import check_call
 
-import edx_theme
+import sphinx_book_theme
 from django import setup as django_setup
 
 
@@ -37,9 +37,44 @@ def get_version(*file_paths):
 
 VERSION = get_version('../learner_pathway_progress', '__init__.py')
 
-# Configure Django for autodoc usage
-os.environ['DJANGO_SETTINGS_MODULE'] = 'test_settings'
-django_setup()
+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'
+
+
+html_theme_options = {
+
+    "repository_url": 'https://github.com/huniafatima-arbi/learner-pathway-progress',
+    "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": """
+        <a rel="license" href="https://creativecommons.org/licenses/by-sa/4.0/">
+            <img
+                alt="Creative Commons License"
+                style="border-width:0"
+                src="https://i.creativecommons.org/l/by-sa/4.0/80x15.png"/>
+        </a>
+        <br>
+        These works by
+            <a
+                xmlns:cc="https://creativecommons.org/ns#"
+                href="https://edx.org"
+                property="cc:attributionName"
+                rel="cc:attributionURL"
+            >edX LLC</a>
+        are licensed under a
+            <a
+                rel="license"
+                href="https://creativecommons.org/licenses/by-sa/4.0/"
+            >Creative Commons Attribution-ShareAlike 4.0 International License</a>.
+    """
+}
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -59,7 +94,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 +125,8 @@ def get_version(*file_paths):
 
 # General information about the project.
 project = 'learner-pathway-progress'
-copyright = edx_theme.COPYRIGHT  # pylint: disable=redefined-builtin
-author = edx_theme.AUTHOR
+copyright = '2024, edX LLC'  # pylint: disable=redefined-builtin
+author = 'edX LLC'
 project_title = 'learner-pathway-progress'
 documentation_title = f"{project_title}"
 
@@ -162,16 +197,12 @@ 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.

learner_pathway_progress/__init__.py

@@ -2,6 +2,6 @@
 A plugin to track learners progress in pathways..
 """
 
-__version__ = '1.3.4'
+__version__ = '1.4.0'
 
 default_app_config = 'learner_pathway_progress.apps.LearnerPathwayProgressConfig'  # pylint: disable=invalid-name

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

requirements/doc.txt

@@ -4,6 +4,8 @@
 #
 #    make upgrade
 #
+accessible-pygments==0.0.5
+    # via pydata-sphinx-theme
 alabaster==0.7.13
     # via sphinx
 amqp==5.2.0
@@ -32,8 +34,6 @@ asn1crypto==1.5.1
     # via
     #   -r requirements/test.txt
     #   snowflake-connector-python
-babel==2.13.1
-    # via sphinx
 backports-zoneinfo[tzdata]==0.2.1
     # via
     #   -r requirements/test.txt
@@ -44,6 +44,13 @@ billiard==4.2.0
     # via
     #   -r requirements/test.txt
     #   celery
+    #   pytest
+babel==2.13.1
+    # via
+    #   pydata-sphinx-theme
+    #   sphinx
+beautifulsoup4==4.12.3
+    # via pydata-sphinx-theme
 bleach==6.1.0
     # via
     #   -r requirements/test.txt
@@ -130,7 +137,6 @@ distro==1.8.0
 django==3.2.23
     # via
     #   -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
-    #   -r requirements/test.txt
     #   django-config-models
     #   django-crum
     #   django-fernet-fields-v2
@@ -223,6 +229,7 @@ doc8==1.1.1
 docutils==0.19
     # via
     #   doc8
+    #   pydata-sphinx-theme
     #   readme-renderer
     #   restructuredtext-lint
     #   sphinx
@@ -263,8 +270,6 @@ edx-rest-api-client==5.6.1
     # via
     #   -r requirements/test.txt
     #   edx-enterprise
-edx-sphinx-theme==3.1.0
-    # via -r requirements/doc.in
 edx-tincan-py35==1.0.0
     # via
     #   -r requirements/test.txt
@@ -374,6 +379,7 @@ packaging==23.2
     # via
     #   -r requirements/test.txt
     #   build
+    #   pydata-sphinx-theme
     #   pytest
     #   snowflake-connector-python
     #   sphinx
@@ -432,9 +438,13 @@ pydantic-core==2.14.5
     # via
     #   -r requirements/test.txt
     #   pydantic
-pygments==2.17.2
+pydata-sphinx-theme==0.15.4
+    # via sphinx-book-theme
+pygments==2.12.0
     # via
+    #   accessible-pygments
     #   doc8
+    #   pydata-sphinx-theme
     #   readme-renderer
     #   rich
     #   sphinx
@@ -531,7 +541,7 @@ six==1.16.0
     #   -r requirements/test.txt
     #   bleach
     #   edx-rbac
-    #   edx-sphinx-theme
+    #   pyjwkest
     #   python-dateutil
 slumber==0.7.1
     # via
@@ -550,15 +560,20 @@ snowflake-connector-python==3.6.0
     # via
     #   -r requirements/test.txt
     #   edx-enterprise
+soupsieve==2.5
+    # via beautifulsoup4
 sortedcontainers==2.4.0
     # via
     #   -r requirements/test.txt
     #   snowflake-connector-python
 sphinx==5.3.0
     # via
     #   -r requirements/doc.in
-    #   edx-sphinx-theme
-sphinxcontrib-applehelp==1.0.4
+    #   pydata-sphinx-theme
+    #   sphinx-book-theme
+sphinx-book-theme==1.1.3
+    # via -r requirements/doc.in
+sphinxcontrib-applehelp==1.0.2
     # via sphinx
 sphinxcontrib-devhelp==1.0.2
     # via sphinx
@@ -621,6 +636,7 @@ typing-extensions==4.9.0
     #   pydantic
     #   pydantic-core
     #   rich
+    #   pydata-sphinx-theme
     #   snowflake-connector-python
 tzdata==2023.3
     # via