diff options
| author | Paolo Bonzini <pbonzini@redhat.com> | 2021-09-07 15:58:12 +0200 |
|---|---|---|
| committer | Paolo Bonzini <pbonzini@redhat.com> | 2021-09-13 13:56:26 +0200 |
| commit | 8a1f7d299c75468af0f761ae9382b129be9d5774 (patch) | |
| tree | 899021bbaa9140a2e26d6121d2051d463f097dc3 /docs | |
| parent | 52fb8ad37aab791640174048b3d90ce9a576af63 (diff) | |
| download | qemu-8a1f7d299c75468af0f761ae9382b129be9d5774.zip qemu-8a1f7d299c75468af0f761ae9382b129be9d5774.tar.gz qemu-8a1f7d299c75468af0f761ae9382b129be9d5774.tar.bz2 | |
docs: standardize book titles to === with overline
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.
Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/system/qemu-block-drivers.rst | 1 | ||||
| -rw-r--r-- | docs/system/qemu-cpu-models.rst | 1 | ||||
| -rw-r--r-- | docs/system/qemu-manpage.rst | 5 | ||||
| -rw-r--r-- | docs/tools/qemu-img.rst | 1 | ||||
| -rw-r--r-- | docs/tools/qemu-nbd.rst | 1 | ||||
| -rw-r--r-- | docs/tools/qemu-pr-helper.rst | 1 | ||||
| -rw-r--r-- | docs/tools/qemu-storage-daemon.rst | 1 | ||||
| -rw-r--r-- | docs/tools/qemu-trace-stap.rst | 1 |
9 files changed, 11 insertions, 2 deletions
diff --git a/docs/index.rst b/docs/index.rst index 5f7eaaa..0b9ee99 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,6 +3,7 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. +================================ Welcome to QEMU's documentation! ================================ diff --git a/docs/system/qemu-block-drivers.rst b/docs/system/qemu-block-drivers.rst index bd99d4f..eb27648 100644 --- a/docs/system/qemu-block-drivers.rst +++ b/docs/system/qemu-block-drivers.rst @@ -1,5 +1,6 @@ :orphan: +============================ QEMU block drivers reference ============================ diff --git a/docs/system/qemu-cpu-models.rst b/docs/system/qemu-cpu-models.rst index 53d7538..8c51e2b 100644 --- a/docs/system/qemu-cpu-models.rst +++ b/docs/system/qemu-cpu-models.rst @@ -1,5 +1,6 @@ :orphan: +================================== QEMU / KVM CPU model configuration ================================== diff --git a/docs/system/qemu-manpage.rst b/docs/system/qemu-manpage.rst index e9a25d0..d6f44e2 100644 --- 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 +======================= Synopsis -------- diff --git a/docs/tools/qemu-img.rst b/docs/tools/qemu-img.rst index b7d602a..fe6c30d 100644 --- a/docs/tools/qemu-img.rst +++ b/docs/tools/qemu-img.rst @@ -1,3 +1,4 @@ +======================= QEMU disk image utility ======================= diff --git a/docs/tools/qemu-nbd.rst b/docs/tools/qemu-nbd.rst index ee862fa..e39a9f4 100644 --- a/docs/tools/qemu-nbd.rst +++ b/docs/tools/qemu-nbd.rst @@ -1,3 +1,4 @@ +===================================== QEMU Disk Network Block Device Server ===================================== diff --git a/docs/tools/qemu-pr-helper.rst b/docs/tools/qemu-pr-helper.rst index ac03618..eaebe40 100644 --- a/docs/tools/qemu-pr-helper.rst +++ b/docs/tools/qemu-pr-helper.rst @@ -1,3 +1,4 @@ +================================== QEMU persistent reservation helper ================================== diff --git a/docs/tools/qemu-storage-daemon.rst b/docs/tools/qemu-storage-daemon.rst index 3ec4bdd..b8ef448 100644 --- a/docs/tools/qemu-storage-daemon.rst +++ b/docs/tools/qemu-storage-daemon.rst @@ -1,3 +1,4 @@ +=================== QEMU Storage Daemon =================== diff --git a/docs/tools/qemu-trace-stap.rst b/docs/tools/qemu-trace-stap.rst index fb70445..d53073b 100644 --- a/docs/tools/qemu-trace-stap.rst +++ b/docs/tools/qemu-trace-stap.rst @@ -1,3 +1,4 @@ +========================= QEMU SystemTap trace tool ========================= |