Re: [PATCH v3] Documentation/sphinx: Fix Directive import error

From: Jani Nikula
Date: Fri Mar 02 2018 - 14:01:12 EST


On Fri, 02 Mar 2018, Matthew Wilcox <willy@xxxxxxxxxxxxx> wrote:
> From: Matthew Wilcox <mawilcox@xxxxxxxxxxxxx>
>
> Sphinx 1.7 removed sphinx.util.compat.Directive so people
> who have upgraded cannot build the documentation. Switch to
> docutils.parsers.rst.Directive which has been available since
> docutils 0.5 released in 2009.
>
> Bugzilla: https://bugzilla.opensuse.org/show_bug.cgi?id=1083694
> Co-developed-by: Takashi Iwai <tiwai@xxxxxxx>
> Signed-off-by: Matthew Wilcox <mawilcox@xxxxxxxxxxxxx>

I think this is the best approach.

FWIW,

Acked-by: Jani Nikula <jani.nikula@xxxxxxxxx>

>
> diff --git a/Documentation/sphinx/kerneldoc.py b/Documentation/sphinx/kerneldoc.py
> index 39aa9e8697cc..fbedcc39460b 100644
> --- a/Documentation/sphinx/kerneldoc.py
> +++ b/Documentation/sphinx/kerneldoc.py
> @@ -36,8 +36,7 @@ import glob
>
> from docutils import nodes, statemachine
> from docutils.statemachine import ViewList
> -from docutils.parsers.rst import directives
> -from sphinx.util.compat import Directive
> +from docutils.parsers.rst import directives, Directive
> from sphinx.ext.autodoc import AutodocReporter
>
> __version__ = '1.0'

--
Jani Nikula, Intel Open Source Technology Center