[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
- [PATCH 0/5] docs: reorganize target-i386 to make room for SGX, Paolo Bonzini, 2021/09/07
- [PATCH 1/5] docs: standardize book titles to === with overline, Paolo Bonzini, 2021/09/07
- [PATCH 3/5] docs/system: standardize docs/system man page sections to --- with overline, Paolo Bonzini, 2021/09/07
- [PATCH 4/5] docs/system: move x86 CPU configuration to a separate document, Paolo Bonzini, 2021/09/07
- [PATCH 2/5] docs: standardize directory index to --- with overline, Paolo Bonzini, 2021/09/07
- Re: [PATCH 2/5] docs: standardize directory index to --- with overline,
Peter Maydell <=
- [PATCH 5/5] docs/system: move SGX documentation within the system docs, Paolo Bonzini, 2021/09/07