From: Peter Maydell <peter.maydell@linaro.org>
To: Paolo Bonzini <pbonzini@redhat.com>
Cc: QEMU Developers <qemu-devel@nongnu.org>
Subject: Re: [PATCH 1/5] docs: standardize book titles to === with overline
Date: Tue, 7 Sep 2021 17:08:06 +0100 [thread overview]
Message-ID: <CAFEAcA9pw1WXbBXGjMYBLVuZp=r_8-cKOOs0_pz=-FFQL=1udw@mail.gmail.com> (raw)
In-Reply-To: <20210907155641.197844-2-pbonzini@redhat.com>
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
next prev parent reply other threads:[~2021-09-07 16:10 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-07 15:56 [PATCH 0/5] docs: reorganize target-i386 to make room for SGX Paolo Bonzini
2021-09-07 15:56 ` [PATCH 1/5] docs: standardize book titles to === with overline Paolo Bonzini
2021-09-07 16:08 ` Peter Maydell [this message]
2021-09-07 15:56 ` [PATCH 2/5] docs: standardize directory index to --- " Paolo Bonzini
2021-09-07 16:08 ` Peter Maydell
2021-09-07 15:56 ` [PATCH 3/5] docs/system: standardize docs/system man page sections " Paolo Bonzini
2021-09-07 16:21 ` Peter Maydell
2021-09-07 15:56 ` [PATCH 4/5] docs/system: move x86 CPU configuration to a separate document Paolo Bonzini
2021-09-07 16:23 ` Peter Maydell
2021-09-07 15:56 ` [PATCH 5/5] docs/system: move SGX documentation within the system docs Paolo Bonzini
2021-09-07 16:28 ` Peter Maydell
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAFEAcA9pw1WXbBXGjMYBLVuZp=r_8-cKOOs0_pz=-FFQL=1udw@mail.gmail.com' \
--to=peter.maydell@linaro.org \
--cc=pbonzini@redhat.com \
--cc=qemu-devel@nongnu.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).