motorhead/qemu
1
0
Fork 0
mirror of https://github.com/Motorhead1991/qemu.git synced 2025-08-03 07:43:54 -06:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: standardize directory index to --- with overline

Browse source 
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>
This commit is contained in:
Paolo Bonzini 2021-09-07 16:01:28 +02:00
parent 8a1f7d299c
commit 06905f6402
7 changed files with 14 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

3
docs/devel/index.rst
View file

@ -1,5 +1,6 @@
---------------------
Developer Information
=====================
---------------------
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