Repository navigation
Sphinx 1.6.3 deprecation warning for sphinx.util.compat.Directive in docs builds #75122
Description
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = <Date 2017-07-24.09:02:21.134>
created_at = <Date 2017-07-15.19:19:13.621>
labels = ['3.7', 'docs']
title = 'Sphinx 1.6.3 deprecation warning for sphinx.util.compat.Directive in docs builds'
updated_at = <Date 2019-05-10.18:16:15.459>
user = 'https://github.com/ned-deily'bugs.python.org fields:
activity = <Date 2019-05-10.18:16:15.459>
actor = 'ned.deily'
assignee = 'docs@python'
closed = True
closed_date = <Date 2017-07-24.09:02:21.134>
closer = 'ned.deily'
components = ['Documentation']
creation = <Date 2017-07-15.19:19:13.621>
creator = 'ned.deily'
dependencies = []
files = []
hgrepos = []
issue_num = 30939
keywords = []
message_count = 8.0
messages = ['298401', '298402', '298404', '298405', '298409', '298451', '298461', '298864']
nosy_count = 4.0
nosy_names = ['brett.cannon', 'larry', 'ned.deily', 'docs@python']
pr_nums = ['2721', '2719', '2722', '2723', '2724', '2725']
priority = 'normal'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue30939'
versions = ['Python 2.7', 'Python 3.3', 'Python 3.4', 'Python 3.5', 'Python 3.6', 'Python 3.7']
Activity
ned-deily commentedon Jul 15, 2017
[..]/sphinx/util/compat.py:40: RemovedInSphinx17Warning: sphinx.util.compat.Directive is deprecated and will be removed in Sphinx 1.7, please use docutils' instead.
RemovedInSphinx17Warning)
The solution is to import Directive directly from docutils. PR to follow for master, needs to be cherrypicked to all maintenance branches and, ideally, all current security-only branches.
ned-deily commentedon Jul 15, 2017
New changeset 50f5816 by Ned Deily in branch 'master':
bpo-30939: Avoid Sphinx deprecation warning in docs build. (bpo-2721)
50f5816
ned-deily commentedon Jul 15, 2017
New changeset bbd0f42 by Ned Deily in branch '3.6':
bpo-30939: Avoid Sphinx deprecation warning in docs build. (bpo-2721) (bpo-2722)
bbd0f42
ned-deily commentedon Jul 15, 2017
New changeset ada3f31 by Ned Deily in branch '3.5':
bpo-30939: Avoid Sphinx deprecation warning in docs build. (bpo-2721) (bpo-2723)
ada3f31
ned-deily commentedon Jul 16, 2017
New changeset 64a9f3d by Ned Deily in branch '2.7':
bpo-30939: Avoid Sphinx deprecation warning in docs build. (bpo-2721) (bpo-2725)
64a9f3d
brettcannon commentedon Jul 16, 2017
I wonder if we should pin sphinx directly instead of the approximate pin we
have now to prevent this sort of thing in the future? I had figured they
wouldn't introduce a new warning in a bugfix release but I was wrong in
that assumption.
On Sat, Jul 15, 2017, 12:19 Ned Deily, <report@bugs.python.org> wrote:
ned-deily commentedon Jul 17, 2017
Perhaps. OTOH, we will find out about Sphinx incompatibilities pretty quickly that way, rather than having doc builds potentially silently fail or only finding out about the problem at release time.
larryhastings commentedon Jul 22, 2017
New changeset 3b3a5a5 by larryhastings (Ned Deily) in branch '3.4':
bpo-30939: Avoid Sphinx deprecation warning in docs build. (bpo-2721) (bpo-2724)
3b3a5a5