* [PATCH] doc: rebuild all Sphinx guides
@ 2023-02-07 8:43 Thomas Monjalon
2023-02-07 8:54 ` David Marchand
0 siblings, 1 reply; 4+ messages in thread
From: Thomas Monjalon @ 2023-02-07 8:43 UTC (permalink / raw)
To: dev; +Cc: Luca Boccassi, Bruce Richardson, David Marchand, John McNamara
On some systems, Sphinx is lazy enough to not recompile an RST file,
even if it contains a link pointing to a file which has been removed.
In order to detect such broken links,
the option "-a" is used to always rebuild all.
Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
doc/guides/meson.build | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/doc/guides/meson.build b/doc/guides/meson.build
index 03b8bee567..51f81da2e3 100644
--- a/doc/guides/meson.build
+++ b/doc/guides/meson.build
@@ -7,7 +7,7 @@ if not sphinx.found()
subdir_done()
endif
-extra_sphinx_args = []
+extra_sphinx_args = ['-a']
if get_option('werror')
extra_sphinx_args += '-W'
endif
--
2.39.1
^ permalink raw reply [flat|nested] 4+ messages in thread* Re: [PATCH] doc: rebuild all Sphinx guides
2023-02-07 8:43 [PATCH] doc: rebuild all Sphinx guides Thomas Monjalon
@ 2023-02-07 8:54 ` David Marchand
2023-02-07 9:09 ` Thomas Monjalon
0 siblings, 1 reply; 4+ messages in thread
From: David Marchand @ 2023-02-07 8:54 UTC (permalink / raw)
To: Thomas Monjalon
Cc: dev, Luca Boccassi, Bruce Richardson, John McNamara, Maxime Coquelin
On Tue, Feb 7, 2023 at 9:44 AM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> On some systems, Sphinx is lazy enough to not recompile an RST file,
> even if it contains a link pointing to a file which has been removed.
>
> In order to detect such broken links,
> the option "-a" is used to always rebuild all.
I can't reproduce such behavior, but the principle looks ok to me and
I did not notice a difference in terms of time spending generating the
documentation.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
We have no guide describing Sphinx, I'd rather update this patch title
like "doc: rebuild all guides with Sphinx".
Reviewed-by: David Marchand <david.marchand@redhat.com>
--
David Marchand
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] doc: rebuild all Sphinx guides
2023-02-07 8:54 ` David Marchand
@ 2023-02-07 9:09 ` Thomas Monjalon
2023-02-14 11:31 ` Thomas Monjalon
0 siblings, 1 reply; 4+ messages in thread
From: Thomas Monjalon @ 2023-02-07 9:09 UTC (permalink / raw)
To: David Marchand
Cc: dev, Luca Boccassi, Bruce Richardson, John McNamara, Maxime Coquelin
07/02/2023 09:54, David Marchand:
> On Tue, Feb 7, 2023 at 9:44 AM Thomas Monjalon <thomas@monjalon.net> wrote:
> >
> > On some systems, Sphinx is lazy enough to not recompile an RST file,
> > even if it contains a link pointing to a file which has been removed.
> >
> > In order to detect such broken links,
> > the option "-a" is used to always rebuild all.
>
> I can't reproduce such behavior, but the principle looks ok to me and
> I did not notice a difference in terms of time spending generating the
> documentation.
I think your system behaves with -a option forced somewhere.
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
>
> We have no guide describing Sphinx, I'd rather update this patch title
> like "doc: rebuild all guides with Sphinx".
Yes
> Reviewed-by: David Marchand <david.marchand@redhat.com>
^ permalink raw reply [flat|nested] 4+ messages in thread
* Re: [PATCH] doc: rebuild all Sphinx guides
2023-02-07 9:09 ` Thomas Monjalon
@ 2023-02-14 11:31 ` Thomas Monjalon
0 siblings, 0 replies; 4+ messages in thread
From: Thomas Monjalon @ 2023-02-14 11:31 UTC (permalink / raw)
To: dev
Cc: David Marchand, Luca Boccassi, Bruce Richardson, John McNamara,
Maxime Coquelin
07/02/2023 10:09, Thomas Monjalon:
> 07/02/2023 09:54, David Marchand:
> > On Tue, Feb 7, 2023 at 9:44 AM Thomas Monjalon <thomas@monjalon.net> wrote:
> > >
> > > On some systems, Sphinx is lazy enough to not recompile an RST file,
> > > even if it contains a link pointing to a file which has been removed.
> > >
> > > In order to detect such broken links,
> > > the option "-a" is used to always rebuild all.
> >
> > I can't reproduce such behavior, but the principle looks ok to me and
> > I did not notice a difference in terms of time spending generating the
> > documentation.
>
> I think your system behaves with -a option forced somewhere.
>
> > > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> >
> > We have no guide describing Sphinx, I'd rather update this patch title
> > like "doc: rebuild all guides with Sphinx".
>
> Yes
>
> > Reviewed-by: David Marchand <david.marchand@redhat.com>
Applied
^ permalink raw reply [flat|nested] 4+ messages in thread
end of thread, other threads:[~2023-02-14 11:31 UTC | newest]
Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-02-07 8:43 [PATCH] doc: rebuild all Sphinx guides Thomas Monjalon
2023-02-07 8:54 ` David Marchand
2023-02-07 9:09 ` Thomas Monjalon
2023-02-14 11:31 ` Thomas Monjalon
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).