2022-03-26 20:18:28

by Mauro Carvalho Chehab

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

Em Sat, 26 Mar 2022 19:33:38 +0700
Bagas Sanjaya <[email protected]> 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 <[email protected]>
> Cc: "David S. Miller" <[email protected]>
> Cc: Greg Kroah-Hartman <[email protected]>
> Cc: "Rafael J. Wysocki" <[email protected]>
> Cc: Jens Axboe <[email protected]>
> Cc: Mauro Carvalho Chehab <[email protected]>
> Cc: Akira Yokosawa <[email protected]>
> Cc: [email protected]
> Signed-off-by: Bagas Sanjaya <[email protected]>

Reviewed-by: Mauro Carvalho Chehab <[email protected]>

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