IntenseWebs/sphinx_rtd_theme
3
0
Fork 0
mirror of https://github.com/readthedocs/sphinx_rtd_theme.git synced 2025-02-25 18:55:21 -06:00
Code Issues Packages Projects Releases Wiki Activity

Require Sphinx 1.6 deprecate html4 (#1091)

Browse Source 
Sphinx 1.6 is required for de76c03824 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
This commit is contained in:
Aaron Carlisle 2021-03-15 18:05:20 -04:00 committed by GitHub
parent 68d4b8aac7
commit 114fb85b44
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 20 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/installing.rst
View File

@ -45,3 +45,11 @@ Symlink or subtree the ``sphinx_rtd_theme/sphinx_rtd_theme`` repository into you
html_theme = "sphinx_rtd_theme" html_theme = "sphinx_rtd_theme"
html_theme_path = ["_themes", ] 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
setup.py
View File

@ -117,7 +117,7 @@ setup(
] ]
}, },
install_requires=[ install_requires=[
'sphinx' 'sphinx>=1.6'
], ],
tests_require=[ tests_require=[
'pytest', 'pytest',

20
sphinx_rtd_theme/__init__.py
View File

@ -8,12 +8,7 @@ from os import path
from sphinx import version_info from sphinx import version_info
from sphinx.locale import _ from sphinx.locale import _
from sphinx.util.logging import getLogger
try:
# Avaliable from Sphinx 1.6
from sphinx.util.logging import getLogger
except ImportError:
from logging import getLogger
__version__ = '0.5.1' __version__ = '0.5.1'
@ -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 # See http://www.sphinx-doc.org/en/stable/theming.html#distribute-your-theme-as-a-python-package
def setup(app): def setup(app):
if version_info >= (1, 6, 0): app.require_sphinx('1.6')
# Register the theme that can be referenced without adding a theme path if version_info <= (2, 0, 0):
app.add_html_theme('sphinx_rtd_theme', path.abspath(path.dirname(__file__))) 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): if version_info >= (1, 8, 0):
# Add Sphinx message catalog for newer versions of Sphinx # Add Sphinx message catalog for newer versions of Sphinx