mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-09-07 22:31:51 +00:00
Kristal Dale
1e2b3fdfa4
-Replace instances of CLOSIA substitution with CL-ATTR. -Replace in-line use of Clear Linux with CL. -Clean up white space. -Limited clean up in collab section, in pref of future rework -Set landing page toctree to use maxdepth 1 Signed-off-by: Kristal Dale <kristal.dale@intel.com>
31 lines
806 B
ReStructuredText
31 lines
806 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 |CL-ATTR| 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>`.
|