Re: [PATCH v2 2/2] Documentation: sphinx: replace "Introduction" chapter heading with page title

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Em Sat, 26 Mar 2022 19:33:38 +0700
Bagas Sanjaya <bagasdotme@xxxxxxxxx> escreveu:

> Replace first chapter heading ("Introduction") with page title named
> "Using Sphinx for kernel documentation". This way, the first-level TOC
> for doc-guide contains title instead of chapter headings for this page.
> 
> Cc: Jonathan Corbet <corbet@xxxxxxx>
> Cc: "David S. Miller" <davem@xxxxxxxxxxxxx>
> Cc: Greg Kroah-Hartman <gregkh@xxxxxxxxxxxxxxxxxxx>
> Cc: "Rafael J. Wysocki" <rafael.j.wysocki@xxxxxxxxx>
> Cc: Jens Axboe <axboe@xxxxxxxxx>
> Cc: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>
> Cc: Akira Yokosawa <akiyks@xxxxxxxxx>
> Cc: linux-kernel@xxxxxxxxxxxxxxx
> Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>

Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@xxxxxxxxxx>

> ---
>  Documentation/doc-guide/sphinx.rst | 5 +++--
>  1 file changed, 3 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/doc-guide/sphinx.rst b/Documentation/doc-guide/sphinx.rst
> index bb36f18ae9ac3e..2ff1ab4158d48e 100644
> --- a/Documentation/doc-guide/sphinx.rst
> +++ b/Documentation/doc-guide/sphinx.rst
> @@ -1,7 +1,8 @@
>  .. _sphinxdoc:
>  
> -Introduction
> -============
> +=====================================
> +Using Sphinx for kernel documentation
> +=====================================
>  
>  The Linux kernel uses `Sphinx`_ to generate pretty documentation from
>  `reStructuredText`_ files under ``Documentation``. To build the documentation in



Thanks,
Mauro



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux