]> git.proxmox.com Git - mirror_qemu.git/commit
docs: standardize directory index to --- with overline
authorPaolo Bonzini <pbonzini@redhat.com>
Tue, 7 Sep 2021 14:01:28 +0000 (16:01 +0200)
committerPaolo Bonzini <pbonzini@redhat.com>
Mon, 13 Sep 2021 11:56:26 +0000 (13:56 +0200)
commit06905f640242c927f07e8c4b45fd4061ffa235ef
treecf592817e57952f6bd910b8d54937f58bcc3acea
parent8a1f7d299c75468af0f761ae9382b129be9d5774
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>
docs/about/index.rst
docs/devel/index.rst
docs/interop/index.rst
docs/specs/index.rst
docs/system/index.rst
docs/tools/index.rst
docs/user/index.rst