From 00c30679cfe6385b16274f9f32300e574dff8ec3 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Mon, 16 Dec 2019 01:38:17 +0900 Subject: [PATCH] Deprecate sphinx.io.FiletypeNotFoundError and get_filetype() --- CHANGES | 3 +++ doc/extdev/deprecated.rst | 10 ++++++++++ sphinx/io.py | 13 ++++++++++++- 3 files changed, 25 insertions(+), 1 deletion(-) diff --git a/CHANGES b/CHANGES index 13a0a3c93..6319fc8a3 100644 --- a/CHANGES +++ b/CHANGES @@ -10,6 +10,9 @@ Incompatible changes Deprecated ---------- +* ``sphinx.io.FiletypeNotFoundError`` +* ``sphinx.io.get_filetype()`` + Features added -------------- diff --git a/doc/extdev/deprecated.rst b/doc/extdev/deprecated.rst index 482cb50bb..9fdaa2f96 100644 --- a/doc/extdev/deprecated.rst +++ b/doc/extdev/deprecated.rst @@ -26,6 +26,16 @@ The following is a list of deprecated interfaces. - (will be) Removed - Alternatives + * - ``sphinx.io.FiletypeNotFoundError`` + - 2.4 + - 4.0 + - ``sphinx.errors.FiletypeNotFoundError`` + + * - ``sphinx.io.get_filetype()`` + - 2.4 + - 4.0 + - ``sphinx.util.get_filetype()`` + * - ``sphinx.builders.gettext.POHEADER`` - 2.3 - 4.0 diff --git a/sphinx/io.py b/sphinx/io.py index fb389a4a3..72762f46c 100644 --- a/sphinx/io.py +++ b/sphinx/io.py @@ -19,7 +19,10 @@ from docutils.statemachine import StringList, string2lines from docutils.transforms.references import DanglingReferences from docutils.writers import UnfilteredWriter -from sphinx.deprecation import RemovedInSphinx30Warning, RemovedInSphinx40Warning +from sphinx.deprecation import ( + RemovedInSphinx30Warning, RemovedInSphinx40Warning, deprecated_alias +) +from sphinx.errors import FiletypeNotFoundError from sphinx.transforms import ( AutoIndexUpgrader, DoctreeReadEvent, FigureAligner, SphinxTransformer ) @@ -335,3 +338,11 @@ def read_doc(app, env, filename): pub.publish() return pub.document + + +deprecated_alias('sphinx.io', + { + 'FiletypeNotFoundError': FiletypeNotFoundError, + 'get_filetype': get_filetype, + }, + RemovedInSphinx40Warning)