New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix #10666: Prepare for removal of sphinx.util.compat module at Sphinx 1.7 #10668

Merged
merged 2 commits into from Jun 21, 2017

Conversation

Projects
None yet
3 participants
@jfbu
Contributor

jfbu commented Jun 21, 2017

Since Sphinx 1.6, the sphinx.util.compat.Directive class is deprecated. And the entire sphinx.util.compat module will be removed at 1.7. This PR follows Sphinx CHANGES tip about using docutils.parsers.rst.Directive instead.

Relates #10666

@jfbu

This comment has been minimized.

Show comment
Hide comment
@jfbu

jfbu Jun 21, 2017

Contributor

@takluyver Thanks, your comment prompted me into looking at what happened exactly in sphinx.util.compat regarding Directive. In fact it has always been since Sphinx 1.3 (required by IPython currently) done like this:

from docutils.parsers.rst import Directive

and there was no other Directive related code there. Hence I made my life more miserable when I checked Sphinx version.

Contributor

jfbu commented Jun 21, 2017

@takluyver Thanks, your comment prompted me into looking at what happened exactly in sphinx.util.compat regarding Directive. In fact it has always been since Sphinx 1.3 (required by IPython currently) done like this:

from docutils.parsers.rst import Directive

and there was no other Directive related code there. Hence I made my life more miserable when I checked Sphinx version.

@takluyver

This comment has been minimized.

Show comment
Hide comment
@takluyver

takluyver Jun 21, 2017

Member

Thanks for taking the time to dig into both projects. I'm happy that we can simply switch the import to use docutils without a version check.

Member

takluyver commented Jun 21, 2017

Thanks for taking the time to dig into both projects. I'm happy that we can simply switch the import to use docutils without a version check.

@takluyver takluyver merged commit 815a455 into ipython:master Jun 21, 2017

4 checks passed

codecov/patch Coverage not affected when comparing 0ce5784...1a6d023
Details
codecov/project 66.96% (+0.03%) compared to 0ce5784
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
@takluyver

This comment has been minimized.

Show comment
Hide comment
@takluyver

takluyver Jun 21, 2017

Member

@meeseeksdev backport

Member

takluyver commented Jun 21, 2017

@meeseeksdev backport

meeseeksdev bot pushed a commit that referenced this pull request Jun 21, 2017

Backport PR #10668: Fix #10666: Prepare for removal of sphinx.util.co…
…mpat module at Sphinx 1.7

Since Sphinx 1.6, the ``sphinx.util.compat.Directive`` class is deprecated. And the entire ``sphinx.util.compat`` module will be removed at 1.7. This PR follows [Sphinx CHANGES](http://www.sphinx-doc.org/en/master/changes.html) tip about using ``docutils.parsers.rst.Directive`` instead.

Relates  10666

takluyver added a commit that referenced this pull request Jun 21, 2017

@jfbu jfbu deleted the jfbu:fix_sphinxutilcompat_import branch Jun 21, 2017

@Carreau Carreau added the backported label Jul 20, 2017

@jfbu jfbu referenced this pull request Jan 8, 2018

Closed

ipython warning #4394

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment