diff mbox series

[2/2] UBUNTU: SAUCE: doc: Disable extension incompatible with Sphinx 3

Message ID 20201005145727.64956-3-paolo.pisati@canonical.com
State New
Headers show
Series doc: fix linux-doc FTBFS | expand

Commit Message

Paolo Pisati Oct. 5, 2020, 2:57 p.m. UTC
From: Ben Hutchings <benh@debian.org>

The cdomain extension needs major changes to work with Sphinx 3.
For now, disable it.

Imported from Debian kernel tree:
https://salsa.debian.org/kernel-team/linux/-/blob/master/debian/patches/debian/doc-disable-extension-incompatible-with-sphinx-3.patch

Signed-off-by: Paolo Pisati <paolo.pisati@canonical.com>
---
 Documentation/conf.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Andrea Righi Oct. 5, 2020, 3:46 p.m. UTC | #1
On Mon, Oct 05, 2020 at 04:57:27PM +0200, Paolo Pisati wrote:
> From: Ben Hutchings <benh@debian.org>
> 
> The cdomain extension needs major changes to work with Sphinx 3.
> For now, disable it.
> 
> Imported from Debian kernel tree:
> https://salsa.debian.org/kernel-team/linux/-/blob/master/debian/patches/debian/doc-disable-extension-incompatible-with-sphinx-3.patch
> 
> Signed-off-by: Paolo Pisati <paolo.pisati@canonical.com>
> ---
>  Documentation/conf.py | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index c503188880d9..ed39663af675 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -36,7 +36,7 @@ needs_sphinx = '1.3'
>  # Add any Sphinx extension module names here, as strings. They can be
>  # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
>  # ones.
> -extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain',
> +extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', #y'cdomain',

I'm wondering if the extra "y" is intentional or if it's just a typo. :)

Anyway, the effect is the same, it's just commenting out the 'cdomain'
extension and it's also in the original patch. Apart than this minor
nitpick the change makes sense to me (also PATCH 1/1), therefore:

Acked-by: Andrea Righi <andrea.righi@canonical.com>

>                'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
>                'maintainers_include', 'sphinx.ext.autosectionlabel' ]
>  
> -- 
> 2.27.0
> 
> 
> -- 
> kernel-team mailing list
> kernel-team@lists.ubuntu.com
> https://lists.ubuntu.com/mailman/listinfo/kernel-team
diff mbox series

Patch

diff --git a/Documentation/conf.py b/Documentation/conf.py
index c503188880d9..ed39663af675 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -36,7 +36,7 @@  needs_sphinx = '1.3'
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', 'cdomain',
+extensions = ['kerneldoc', 'rstFlatTable', 'kernel_include', #y'cdomain',
               'kfigure', 'sphinx.ext.ifconfig', 'automarkup',
               'maintainers_include', 'sphinx.ext.autosectionlabel' ]