Skip to content

Commit

Permalink
Require Sphinx 1.6 deprecate html4 (#1091)
Browse files Browse the repository at this point in the history
Sphinx 1.6 is required for de76c03 we also do not test against versions lower than 1.6 so we should safely drop it.

This is similar to #1076 and #1075 but less strict
  • Loading branch information
Blendify committed Mar 15, 2021
1 parent 68d4b8a commit 114fb85
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 10 deletions.
8 changes: 8 additions & 0 deletions docs/installing.rst
Expand Up @@ -45,3 +45,11 @@ Symlink or subtree the ``sphinx_rtd_theme/sphinx_rtd_theme`` repository into you
html_theme = "sphinx_rtd_theme"
html_theme_path = ["_themes", ]
Compatibility
=============

``sphinx_rtd_theme`` depends on at least Sphinx 1.6 although,
we recommend at least Sphinx 2 to take advantage of the html5 writer.
The html4 writer is still supported however,
it is deprecated and support will be removed in the near future.
2 changes: 1 addition & 1 deletion setup.py
Expand Up @@ -117,7 +117,7 @@ def run(self):
]
},
install_requires=[
'sphinx'
'sphinx>=1.6'
],
tests_require=[
'pytest',
Expand Down
20 changes: 11 additions & 9 deletions sphinx_rtd_theme/__init__.py
Expand Up @@ -8,12 +8,7 @@

from sphinx import version_info
from sphinx.locale import _

try:
# Avaliable from Sphinx 1.6
from sphinx.util.logging import getLogger
except ImportError:
from logging import getLogger
from sphinx.util.logging import getLogger


__version__ = '0.5.1'
Expand All @@ -38,9 +33,16 @@ def config_initiated(app, config):

# See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
def setup(app):
if version_info >= (1, 6, 0):
# Register the theme that can be referenced without adding a theme path
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))
app.require_sphinx('1.6')
if version_info <= (2, 0, 0):
if not app.config.html_experimental_html5_writer:
logger.warning("'html4_writer' is deprecated with sphinx_rtd_theme")
else:
if app.config.html4_writer:
logger.warning("'html4_writer' is deprecated with sphinx_rtd_theme")

# Register the theme that can be referenced without adding a theme path
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__)))

if version_info >= (1, 8, 0):
# Add Sphinx message catalog for newer versions of Sphinx
Expand Down

0 comments on commit 114fb85

Please sign in to comment.