diff mbox series

[net-next,1/3] docs: networking: Fix indices heading indentation

Message ID 20180717042906.17308-2-me@tobin.cc
State Changes Requested, archived
Delegated to: David Miller
Headers show
Series docs: Convert alias and bridge to rst | expand

Commit Message

Tobin C. Harding July 17, 2018, 4:29 a.m. UTC
Currently the 'Indices' heading is not aligned with column 0, it should
be.

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(-)

Comments

Markus Heiser July 17, 2018, 8:28 a.m. UTC | #1
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 --

> 
> 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`
Markus Heiser July 17, 2018, 11:45 a.m. UTC | #2
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
Tobin C. Harding July 18, 2018, 3:23 a.m. UTC | #3
On Tue, Jul 17, 2018 at 10:28:15AM +0200, Markus Heiser wrote:
> 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:

Thanks for picking this up Markus.  A little knowledge is dangerous eh
:) Will remove this patch from the set and re-spin.


thanks,
Tobin.
diff mbox series

Patch

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`