summary refs log tree commit diff stats
path: root/python/qemu/machine/machine.py
diff options
context:
space:
mode:
authorPaolo Bonzini <pbonzini@redhat.com>2021-09-07 16:01:28 +0200
committerPaolo Bonzini <pbonzini@redhat.com>2021-09-13 13:56:26 +0200
commit06905f640242c927f07e8c4b45fd4061ffa235ef (patch)
treecf592817e57952f6bd910b8d54937f58bcc3acea /python/qemu/machine/machine.py
parent8a1f7d299c75468af0f761ae9382b129be9d5774 (diff)
downloadfocaccia-qemu-06905f640242c927f07e8c4b45fd4061ffa235ef.tar.gz
focaccia-qemu-06905f640242c927f07e8c4b45fd4061ffa235ef.zip
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>
Diffstat (limited to 'python/qemu/machine/machine.py')
0 files changed, 0 insertions, 0 deletions