Re: [PATCH 1/5] docs: standardize book titles to === with overline

[Peter Maydell]

On Tue, 7 Sept 2021 at 16:56, Paolo Bonzini <pbonzini@redhat.com> wrote:
>
> Documents within a Sphinx manual are separate files and therefore can use
> different conventions for headings.  However, keeping some consistency is
> useful so that included files are easy to get right.
>
> This patch uses a standard heading format for book titles, so that it is
> obvious when a file sits at the top level toctree of a book or man page.
> The heading is irrelevant for man pages, but keep it consistent as well.
>
> Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>

> --- a/docs/system/qemu-manpage.rst
> +++ b/docs/system/qemu-manpage.rst
> @@ -6,8 +6,9 @@
>     parts of the documentation that go in the manpage as well as the
>     HTML manual.
>
> -Title
> -=====
> +=======================
> +QEMU User Documentation
> +=======================

NB that this text is never rendered anywhere (unless you deliberately
edit URLs to go and look at
https://qemu-project.gitlab.io/qemu/system/qemu-manpage.html
which is only generated because AFAIK there is no way to tell
Sphinx "only render this file for this output builder type").

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

thanks
-- PMM