Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Message-ID: <db7c7d48d1e8344a4d78193830a544ee8b6bf43b.camel@darmarit.de>
Subject: Re: [PATCH net-next 1/3] docs: networking: Fix indices heading
 indentation
From:   Markus Heiser <markus.heiser@darmarit.de>
To:     "Tobin C. Harding" <me@tobin.cc>,
        "David S. Miller" <davem@davemloft.net>
Cc:     linux-doc@vger.kernel.org, netdev@vger.kernel.org,
        linux-kernel@vger.kernel.org
Date:   Tue, 17 Jul 2018 13:45:44 +0200
In-Reply-To: <1d7a309eb7561b9bb4c31f5deb9a0b63b6263232.camel@darmarit.de>
References: <20180717042906.17308-1-me@tobin.cc>
         <20180717042906.17308-2-me@tobin.cc>
         <1d7a309eb7561b9bb4c31f5deb9a0b63b6263232.camel@darmarit.de>
Content-Type: text/plain; charset="UTF-8"
Mime-Version: 1.0
Content-Transfer-Encoding: 7bit
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk

Am Dienstag, den 17.07.2018, 10:28 +0200 schrieb Markus Heiser:
> Am Dienstag, den 17.07.2018, 14:29 +1000 schrieb Tobin C. Harding:
> > Currently the 'Indices' heading is not aligned with column 0, it should
> > be.
> 
> Hi Tobin, thats not correct. The 'Indices' heading is a part of the 'only'
> block:
> 
>   http://www.sphinx-doc.org/en/stable/markup/misc.html#including-content-based-on-tags
> 
> -- Markus --

I realized that we have not well documented SPHINXDIRS, to be more elaborate ..

The tag 'subproject' will be set from the networking/conf.py if you run:

   make -k SPHINXDIRS="networking" htmldocs

to just build only the networking folder (aka subproject). For more info,
please run 'make help' and take a look at the 'Documentation targets' section.

In short: a subfolder of Documentation/ with a conf.py file in, is a subproject
and can be build separate.

 -- Markus --


> 
> > 
> > Fix 'Indices' heading indentation.
> > 
> > Signed-off-by: Tobin C. Harding <me@tobin.cc>
> > ---
> >  Documentation/networking/index.rst | 4 ++--
> >  1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/Documentation/networking/index.rst b/Documentation/networking/index.rst
> > index 6123a7e9e1da..a4bbde70bcb9 100644
> > --- a/Documentation/networking/index.rst
> > +++ b/Documentation/networking/index.rst
> > @@ -20,7 +20,7 @@ Contents:
> >  
> >  .. only::  subproject
> >  
> > -   Indices
> > -   =======
> > +Indices
> > +=======
> >  
> >     * :ref:`genindex`
> 
> --
> To unsubscribe from this list: send the line "unsubscribe linux-doc" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html