qemu-devel
[Top][All Lists]
Advanced

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

Re: [PATCH 2/5] docs: standardize directory index to --- with overline


From: Peter Maydell
Subject: Re: [PATCH 2/5] docs: standardize directory index to --- with overline
Date: Tue, 7 Sep 2021 17:08:39 +0100

On Tue, 7 Sept 2021 at 16:56, Paolo Bonzini <pbonzini@redhat.com> wrote:
>
> Use a standard heading format for the index.rst file in a directory.
> Using overlines makes it clear that individual documents can use e.g.
> === for chapter titles and --- for section titles, as suggested in the
> Linux kernel guidelines[1].  They could do it anyway, because documents
> included in a toctree are parsed separately and therefore are not tied
> to the same conventions for headings.  However, keeping some consistency is
> useful since sometimes files are included from multiple places.
>
> [1] https://www.kernel.org/doc/html/latest/doc-guide/sphinx.html
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
> ---

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>

thanks
-- PMM



reply via email to

[Prev in Thread] Current Thread [Next in Thread]