From 0e4c23fc3598ea9eb382e15d12c9101e973564c4 Mon Sep 17 00:00:00 2001 From: Takeshi KOMIYA Date: Sun, 2 Sep 2018 11:32:01 +0900 Subject: [PATCH] Deprecate string style base for env.doc2path() --- CHANGES | 1 + doc/extdev/index.rst | 5 +++++ sphinx/environment/__init__.py | 3 +++ 3 files changed, 9 insertions(+) diff --git a/CHANGES b/CHANGES index 04b9bb9aa..c92a42cbf 100644 --- a/CHANGES +++ b/CHANGES @@ -16,6 +16,7 @@ Deprecated ---------- * The ``suffix`` argument of ``env.doc2path()`` is deprecated. +* The string style ``base`` argument of ``env.doc2path()`` is deprecated. * ``sphinx.ext.doctest.doctest_encode()`` * ``sphinx.testing.util.remove_unicode_literal()`` diff --git a/doc/extdev/index.rst b/doc/extdev/index.rst index 66116d701..8536ffc30 100644 --- a/doc/extdev/index.rst +++ b/doc/extdev/index.rst @@ -121,6 +121,11 @@ The following is a list of deprecated interface. - 4.0 - N/A + * - string style ``base`` argument of ``BuildEnvironment.doc2path()`` + - 2.0 + - 4.0 + - ``os.path.join()`` + * - ``sphinx.ext.doctest.doctest_encode()`` - 2.0 - 4.0 diff --git a/sphinx/environment/__init__.py b/sphinx/environment/__init__.py index eb37d140d..747c25c55 100644 --- a/sphinx/environment/__init__.py +++ b/sphinx/environment/__init__.py @@ -342,6 +342,9 @@ class BuildEnvironment(object): if suffix: warnings.warn('The suffix argument for doc2path() is deprecated.', RemovedInSphinx40Warning) + if base not in (True, None): + warnings.warn('The string style base argument for doc2path() is deprecated.', + RemovedInSphinx40Warning) docname = docname.replace(SEP, path.sep) if suffix is None: