[issue30939] Sphinx 1.6.3 deprecation warning for sphinx.util.compat.Directive in docs builds
New submission from Ned Deily:
[..]/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.
----------
assignee: docs@python
components: Documentation
messages: 298401
nosy: brett.cannon, docs@python, larry, ned.deily
priority: normal
severity: normal
stage: patch review
status: open
title: Sphinx 1.6.3 deprecation warning for sphinx.util.compat.Directive in docs builds
versions: Python 2.7, Python 3.3, Python 3.4, Python 3.5, Python 3.6, Python 3.7
_______________________________________
Python tracker
Changes by Ned Deily
Changes by Larry Hastings
Ned Deily added the comment:
New changeset 50f58163a69abe2f35e91044d1df165ee7bdbb42 by Ned Deily in branch 'master':
bpo-30939: Avoid Sphinx deprecation warning in docs build. (#2721)
https://github.com/python/cpython/commit/50f58163a69abe2f35e91044d1df165ee7b...
----------
_______________________________________
Python tracker
Changes by Ned Deily
Ned Deily added the comment:
New changeset bbd0f423d2a19c6a4a9cda6914fc60b87e17250b by Ned Deily in branch '3.6':
bpo-30939: Avoid Sphinx deprecation warning in docs build. (#2721) (#2722)
https://github.com/python/cpython/commit/bbd0f423d2a19c6a4a9cda6914fc60b87e1...
----------
_______________________________________
Python tracker
Changes by Ned Deily
Ned Deily added the comment:
New changeset ada3f31365d0634d0cd8eeacfacd98291e34a8cc by Ned Deily in branch '3.5':
bpo-30939: Avoid Sphinx deprecation warning in docs build. (#2721) (#2723)
https://github.com/python/cpython/commit/ada3f31365d0634d0cd8eeacfacd98291e3...
----------
_______________________________________
Python tracker
Changes by Ned Deily
Changes by Ned Deily
Ned Deily added the comment:
New changeset 64a9f3d961084819335ea011063eb8cb41733882 by Ned Deily in branch '2.7':
bpo-30939: Avoid Sphinx deprecation warning in docs build. (#2721) (#2725)
https://github.com/python/cpython/commit/64a9f3d961084819335ea011063eb8cb417...
----------
_______________________________________
Python tracker
Brett Cannon added the comment:
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,
New submission from Ned Deily:
[..]/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.
---------- assignee: docs@python components: Documentation messages: 298401 nosy: brett.cannon, docs@python, larry, ned.deily priority: normal severity: normal stage: patch review status: open title: Sphinx 1.6.3 deprecation warning for sphinx.util.compat.Directive in docs builds versions: Python 2.7, Python 3.3, Python 3.4, Python 3.5, Python 3.6, Python 3.7
_______________________________________ Python tracker
http://bugs.python.org/issue30939 _______________________________________
----------
_______________________________________
Python tracker
Ned Deily added the comment:
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?
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.
----------
_______________________________________
Python tracker
Larry Hastings added the comment:
New changeset 3b3a5a5b70dc468dcfacb17a3d6b342820b480ff by larryhastings (Ned Deily) in branch '3.4':
bpo-30939: Avoid Sphinx deprecation warning in docs build. (#2721) (#2724)
https://github.com/python/cpython/commit/3b3a5a5b70dc468dcfacb17a3d6b342820b...
----------
_______________________________________
Python tracker
Changes by Ned Deily
Ned Deily
Change by Ned Deily
participants (3)
-
Brett Cannon
-
Larry Hastings
-
Ned Deily