diff options
| author |   Emma Foley <emma.l.foley@intel.com> | 2018-08-28 14:16:54 +0100 |
|---|---|---|
| committer | Emma Foley <emma.l.foley@intel.com> | 2019-01-16 15:37:18 +0000 |
| commit | 9c10763fedf5103bbd229648b17ee4a36d70e89e (patch) | |
| tree | 82472e534877a06adec52f788432a4f1ae0a269f /docs/testing/user/userguide/10-yardstick-user-interface.rst | |
| parent | 07c506d3fff732019651d89de14bf42fa8d9a365 (diff) | |
[docs] Make heading levels consistent
Update the symbols used to denote different headings
to make them consistent across the userguide.
JIRA: YARDSTICK-1335
Change-Id: Ib5ab1f14bbaa819cf882dc00d68bc27da3f1eadb
Signed-off-by: Emma Foley <emma.l.foley@intel.com>
Diffstat (limited to 'docs/testing/user/userguide/10-yardstick-user-interface.rst')
| -rw-r--r-- | docs/testing/user/userguide/10-yardstick-user-interface.rst | 18 |
1 files changed, 16 insertions, 2 deletions
diff --git a/docs/testing/user/userguide/10-yardstick-user-interface.rst b/docs/testing/user/userguide/10-yardstick-user-interface.rst index b3056ec99..246e1b1df 100644 --- a/docs/testing/user/userguide/10-yardstick-user-interface.rst +++ b/docs/testing/user/userguide/10-yardstick-user-interface.rst @@ -1,3 +1,17 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International +.. License. +.. http://creativecommons.org/licenses/by/4.0 + +.. Convention for heading levels in Yardstick documentation: + + ======= Heading 0 (reserved for the title in a document) + ------- Heading 1 + ^^^^^^^ Heading 2 + +++++++ Heading 3 + ''''''' Heading 4 + + Avoid deeper levels because they do not render well. + ======================== Yardstick User Interface ======================== @@ -18,7 +32,7 @@ The following layouts are available: Commands -======== +-------- To generate the compact HTML report, run:: @@ -30,7 +44,7 @@ To generate the dynamic HTML report, run:: Description -=========== +----------- 1. When the command is triggered, the relevant values for the provided task-id and testcase name are retrieved from the |