[v2] Don't generate netlink .rst files inside $(srctree)

[PATCH v2 12/12] docs: conf.py: don't handle yaml files outside Netlink specs

Posted by Mauro Carvalho Chehab 4 months ago

The parser_yaml extension already has a logic to prevent
handing all yaml documents. However, if we don't also exclude
the patterns at conf.py, the build time would increase a lot,
and warnings like those would be generated:

    Documentation/netlink/genetlink.yaml: WARNING: o documento não está incluído em nenhum toctree
    Documentation/netlink/genetlink-c.yaml: WARNING: o documento não está incluído em nenhum toctree
    Documentation/netlink/genetlink-legacy.yaml: WARNING: o documento não está incluído em nenhum toctree
    Documentation/netlink/index.rst: WARNING: o documento não está incluído em nenhum toctree
    Documentation/netlink/netlink-raw.yaml: WARNING: o documento não está incluído em nenhum toctree

Add some exclusion rules to prevent that.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
---
 Documentation/conf.py | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/Documentation/conf.py b/Documentation/conf.py
index add6ce78dd80..b8668bcaf090 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -222,7 +222,11 @@ language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['output']
+exclude_patterns = [
+	'output',
+	'devicetree/bindings/**.yaml',
+	'netlink/*.yaml',
+]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
-- 
2.49.0

Re: [PATCH v2 12/12] docs: conf.py: don't handle yaml files outside Netlink specs

Posted by Donald Hunter 3 months, 4 weeks ago

Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:

> The parser_yaml extension already has a logic to prevent
> handing all yaml documents. However, if we don't also exclude
> the patterns at conf.py, the build time would increase a lot,
> and warnings like those would be generated:
>
>     Documentation/netlink/genetlink.yaml: WARNING: o documento não está incluído em nenhum toctree
>     Documentation/netlink/genetlink-c.yaml: WARNING: o documento não está incluído em nenhum toctree
>     Documentation/netlink/genetlink-legacy.yaml: WARNING: o documento não está incluído em nenhum toctree
>     Documentation/netlink/index.rst: WARNING: o documento não está incluído em nenhum toctree
>     Documentation/netlink/netlink-raw.yaml: WARNING: o documento não está incluído em nenhum toctree
>
> Add some exclusion rules to prevent that.
>
> Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> ---
>  Documentation/conf.py | 6 +++++-
>  1 file changed, 5 insertions(+), 1 deletion(-)
>
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index add6ce78dd80..b8668bcaf090 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -222,7 +222,11 @@ language = 'en'
>  
>  # List of patterns, relative to source directory, that match files and
>  # directories to ignore when looking for source files.
> -exclude_patterns = ['output']
> +exclude_patterns = [
> +	'output',
> +	'devicetree/bindings/**.yaml',
> +	'netlink/*.yaml',
> +]

Please merge this with the earlier patch that changes these lines so
that the series doesn't contain unnecessary intermediate steps.

>  # The reST default role (used for this markup: `text`) to use for all
>  # documents.

Re: [PATCH v2 12/12] docs: conf.py: don't handle yaml files outside Netlink specs

Posted by Mauro Carvalho Chehab 3 months, 4 weeks ago

Em Fri, 13 Jun 2025 12:52:35 +0100
Donald Hunter <donald.hunter@gmail.com> escreveu:

> Mauro Carvalho Chehab <mchehab+huawei@kernel.org> writes:
> 
> > The parser_yaml extension already has a logic to prevent
> > handing all yaml documents. However, if we don't also exclude
> > the patterns at conf.py, the build time would increase a lot,
> > and warnings like those would be generated:
> >
> >     Documentation/netlink/genetlink.yaml: WARNING: o documento não está incluído em nenhum toctree
> >     Documentation/netlink/genetlink-c.yaml: WARNING: o documento não está incluído em nenhum toctree
> >     Documentation/netlink/genetlink-legacy.yaml: WARNING: o documento não está incluído em nenhum toctree
> >     Documentation/netlink/index.rst: WARNING: o documento não está incluído em nenhum toctree
> >     Documentation/netlink/netlink-raw.yaml: WARNING: o documento não está incluído em nenhum toctree
> >
> > Add some exclusion rules to prevent that.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
> > ---
> >  Documentation/conf.py | 6 +++++-
> >  1 file changed, 5 insertions(+), 1 deletion(-)
> >
> > diff --git a/Documentation/conf.py b/Documentation/conf.py
> > index add6ce78dd80..b8668bcaf090 100644
> > --- a/Documentation/conf.py
> > +++ b/Documentation/conf.py
> > @@ -222,7 +222,11 @@ language = 'en'
> >  
> >  # List of patterns, relative to source directory, that match files and
> >  # directories to ignore when looking for source files.
> > -exclude_patterns = ['output']
> > +exclude_patterns = [
> > +	'output',
> > +	'devicetree/bindings/**.yaml',
> > +	'netlink/*.yaml',
> > +]  
> 
> Please merge this with the earlier patch that changes these lines so
> that the series doesn't contain unnecessary intermediate steps.

OK.

> 
> >  # The reST default role (used for this markup: `text`) to use for all
> >  # documents.  



Thanks,
Mauro