Re: [PATCH v3 06/20] docs: mark orphan documents as such
From: Andy Shevchenko
Date: Tue Jun 11 2019 - 14:28:16 EST
On Tue, Jun 11, 2019 at 8:05 PM Mauro Carvalho Chehab
> Em Tue, 11 Jun 2019 19:52:04 +0300
> Andy Shevchenko <andy.shevchenko@xxxxxxxxx> escreveu:
> > On Fri, Jun 7, 2019 at 10:04 PM Mauro Carvalho Chehab
> > <mchehab+samsung@xxxxxxxxxx> wrote:
> > > Sphinx doesn't like orphan documents:
> > > Documentation/laptops/lg-laptop.rst: WARNING: document isn't included in any toctree
> > > Documentation/laptops/lg-laptop.rst | 2 ++
> > > diff --git a/Documentation/laptops/lg-laptop.rst b/Documentation/laptops/lg-laptop.rst
> > > index aa503ee9b3bc..f2c2ffe31101 100644
> > > --- a/Documentation/laptops/lg-laptop.rst
> > > +++ b/Documentation/laptops/lg-laptop.rst
> > > @@ -1,5 +1,7 @@
> > > .. SPDX-License-Identifier: GPL-2.0+
> > >
> > > +:orphan:
> > > +
> > > LG Gram laptop extra features
> > > =============================
> > >
> > Can we rather create a toc tree there?
> > It was a first document in reST format in that folder.
> Sure, but:
> 1) I have a patch converting the other files on this dir to rst:
> 2) It probably makes sense to move the entire dir to
> So, I would prefer to have the :orphan: here while (1) is not merged.
Fine to me as long as you will drop it by the mentioned effort.
With Best Regards,