diff --git a/source/clear-linux/reference/collaboration/documentation/contents.rst b/source/clear-linux/reference/collaboration/documentation/contents.rst new file mode 100644 index 00000000..554fe4b2 --- /dev/null +++ b/source/clear-linux/reference/collaboration/documentation/contents.rst @@ -0,0 +1,40 @@ +.. _contents: + + +Contents directive +################## + +For |CL| 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: + +Clear Linux Guide Example +************************* + +Introduction +========= + +Step-by-Step +============ + +Launch +====== + + +.. _reStruturedText Directives: http://docutils.sourceforge.net/0.4/docs/ref/rst/directives.html#table-of-contents diff --git a/source/clear-linux/reference/collaboration/documentation/rest.rst b/source/clear-linux/reference/collaboration/documentation/rest.rst index a11522bc..3b1a81f6 100644 --- a/source/clear-linux/reference/collaboration/documentation/rest.rst +++ b/source/clear-linux/reference/collaboration/documentation/rest.rst @@ -36,6 +36,7 @@ templates supplied. cross images code + contents .. _Sphinx documentation: