mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-09-04 21:01:33 +00:00
Rodrigo Caballero
1d7f1c2d14
This section contains all the guidelines, rules, examples, and templates needed to contribute content to the Clear Linux project. The mechanics on how to use Git to contribute the content will be added in the future. Signed-off-by: Rodrigo Caballero <rodrigo.caballero.abraham@intel.com>
31 lines
805 B
ReStructuredText
31 lines
805 B
ReStructuredText
.. _headings:
|
|
|
|
Headings
|
|
########
|
|
|
|
Descriptive and brief headings are crucial to the quality of the
|
|
documentation. Sphinx uses the headings within the
|
|
:abbr:`ReST (RestructuredText)` files to generate the navigation of the HTML
|
|
output and the outlines of the PDF files. The |CLOSIA| publishes the
|
|
documentation as HTML making consistent heading levels extremely important.
|
|
|
|
In addition to the title of the file, only three levels of headings are
|
|
accepted. The following example shows all accepted levels of headings:
|
|
|
|
.. code-block:: rst
|
|
|
|
Title
|
|
#####
|
|
|
|
Level 1 sections
|
|
****************
|
|
|
|
Level 2 sections
|
|
================
|
|
|
|
Level 3 sections
|
|
----------------
|
|
|
|
Headings must be written in sentence case. Learn more about the correct
|
|
capitalization in our :ref:`grammar guide<grammar>`.
|