OpenE2K/qemu-e2k
13
4
Fork 0
Code Issues 4 Pull Requests Projects 2 Releases Activity

docs: standardize book titles to === with overline

Browse Source 
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>
This commit is contained in:
Paolo Bonzini 2021-09-07 15:58:12 +02:00
parent 52fb8ad37a
commit 8a1f7d299c
9 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/index.rst
View File

@ -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!
================================

1
docs/system/qemu-block-drivers.rst
View File

@ -1,5 +1,6 @@
:orphan:
============================
QEMU block drivers reference
============================

1
docs/system/qemu-cpu-models.rst
View File

@ -1,5 +1,6 @@
:orphan:
==================================
QEMU / KVM CPU model configuration
==================================

5
docs/system/qemu-manpage.rst
View File

@ -6,8 +6,9 @@
parts of the documentation that go in the manpage as well as the
HTML manual.
Title
=====
=======================
QEMU User Documentation
=======================
Synopsis
--------

1
docs/tools/qemu-img.rst
View File

@ -1,3 +1,4 @@
=======================
QEMU disk image utility
=======================

1
docs/tools/qemu-nbd.rst
View File

@ -1,3 +1,4 @@
=====================================
QEMU Disk Network Block Device Server
=====================================

1
docs/tools/qemu-pr-helper.rst
View File

@ -1,3 +1,4 @@
==================================
QEMU persistent reservation helper
==================================

1
docs/tools/qemu-storage-daemon.rst
View File

@ -1,3 +1,4 @@
===================
QEMU Storage Daemon
===================

1
docs/tools/qemu-trace-stap.rst
View File

@ -1,3 +1,4 @@
=========================
QEMU SystemTap trace tool
=========================