瀏覽代碼

docs: standardize directory index to --- with overline

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

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
Paolo Bonzini 4 年之前
父節點
當前提交
06905f6402
共有 7 個文件被更改,包括 14 次插入7 次删除
  1. 2 1
      docs/about/index.rst
  2. 2 1
      docs/devel/index.rst
  3. 2 1
      docs/interop/index.rst
  4. 2 1
      docs/specs/index.rst
  5. 2 1
      docs/system/index.rst
  6. 2 1
      docs/tools/index.rst
  7. 2 1
      docs/user/index.rst

+ 2 - 1
docs/about/index.rst

@@ -1,5 +1,6 @@
+----------
 About QEMU
 About QEMU
-==========
+----------
 
 
 QEMU is a generic and open source machine emulator and virtualizer.
 QEMU is a generic and open source machine emulator and virtualizer.
 
 

+ 2 - 1
docs/devel/index.rst

@@ -1,5 +1,6 @@
+---------------------
 Developer Information
 Developer Information
-=====================
+---------------------
 
 
 This section of the manual documents various parts of the internals of QEMU.
 This section of the manual documents various parts of the internals of QEMU.
 You only need to read it if you are interested in reading or
 You only need to read it if you are interested in reading or

+ 2 - 1
docs/interop/index.rst

@@ -1,5 +1,6 @@
+------------------------------------------------
 System Emulation Management and Interoperability
 System Emulation Management and Interoperability
-================================================
+------------------------------------------------
 
 
 This section of the manual contains documents and specifications that
 This section of the manual contains documents and specifications that
 are useful for making QEMU interoperate with other software.
 are useful for making QEMU interoperate with other software.

+ 2 - 1
docs/specs/index.rst

@@ -1,5 +1,6 @@
+----------------------------------------------
 System Emulation Guest Hardware Specifications
 System Emulation Guest Hardware Specifications
-==============================================
+----------------------------------------------
 
 
 This section of the manual contains specifications of
 This section of the manual contains specifications of
 guest hardware that is specific to QEMU.
 guest hardware that is specific to QEMU.

+ 2 - 1
docs/system/index.rst

@@ -1,5 +1,6 @@
+----------------
 System Emulation
 System Emulation
-================
+----------------
 
 
 This section of the manual is the overall guide for users using QEMU
 This section of the manual is the overall guide for users using QEMU
 for full system emulation (as opposed to user-mode emulation).
 for full system emulation (as opposed to user-mode emulation).

+ 2 - 1
docs/tools/index.rst

@@ -1,5 +1,6 @@
+-----
 Tools
 Tools
-=====
+-----
 
 
 This section of the manual documents QEMU's "tools": its
 This section of the manual documents QEMU's "tools": its
 command line utilities and other standalone programs.
 command line utilities and other standalone programs.

+ 2 - 1
docs/user/index.rst

@@ -1,5 +1,6 @@
+-------------------
 User Mode Emulation
 User Mode Emulation
-===================
+-------------------
 
 
 This section of the manual is the overall guide for users using QEMU
 This section of the manual is the overall guide for users using QEMU
 for user-mode emulation.  In this mode, QEMU can launch
 for user-mode emulation.  In this mode, QEMU can launch