docs: Add a deprecation warning.

Bump the version to do a final release with the deprecation warning.
openedx-unsupported · Jan 25, 2023 · a7ce9cd · a7ce9cd
1 parent f4a7a45
commit a7ce9cd
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/edx_theme/__init__.py b/edx_theme/__init__.py
@@ -6,12 +6,17 @@
 
 import datetime
 import os
+from warnings import warn
 
 import six
 from six.moves.urllib.parse import quote  # pylint: disable=wrong-import-order
 
+warn("The edx-sphinx-theme is deprecated.  Switch to the sphinx-boook-theme.  "
+     "See https://docs.openedx.org/en/latest/developers/how-tos/switch-to-the-sphinx-book-theme.html",
+     DeprecationWarning, stacklevel=2)
+
 # When you change this, also update the CHANGELOG.rst file, thanks.
-__version__ = '3.0.0'
+__version__ = '3.0.1'
 
 # Use these constants in the conf.py for Sphinx in your repository
 AUTHOR = 'edX Inc.'