doc: rebuild all Sphinx guides
Checks
Commit Message
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(-)
Comments
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>
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>
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
@@ -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