mirror of
https://github.com/clearlinux/clear-linux-documentation.git
synced 2026-10-03 15:39:59 +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>
41 lines
882 B
ReStructuredText
41 lines
882 B
ReStructuredText
.. _contents:
|
|
|
|
|
|
Contents directive
|
|
##################
|
|
|
|
For |CL-ATTR| documentation that has three or more sections, use the `contents::`
|
|
directive as shown in the example below. This directive automatically captures the headings (and
|
|
subheadings if used) as specified in the value given after `:depth:`. Adding this directive to
|
|
longer documents allows users to quickly navigate to the desired section.
|
|
|
|
.. contents:: :local:
|
|
:depth: 2
|
|
|
|
.. code-block:: bash
|
|
|
|
.. contents:: :local:
|
|
:depth: 2
|
|
|
|
.. note::
|
|
|
|
Assure that you add `:local:` as the value. For more resources on this directive,
|
|
visit the `reStruturedText Directives`_
|
|
|
|
EXAMPLE:
|
|
|
|
Guide Example
|
|
*************
|
|
|
|
Introduction
|
|
============
|
|
|
|
Step-by-Step
|
|
============
|
|
|
|
Launch
|
|
======
|
|
|
|
|
|
.. _reStruturedText Directives: http://docutils.sourceforge.net/0.4/docs/ref/rst/directives.html#table-of-contents
|