diff options
| author |   Volodymyr Mytnyk <volodymyrx.mytnyk@intel.com> | 2019-01-17 09:54:40 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@opnfv.org> | 2019-01-17 09:54:40 +0000 |
| commit | a1b5c651cf66eaf98024e7e9c09632ebfdc53fb6 (patch) | |
| tree | 5ac4b13ad597878adb12f03c91ae9c91f2f3012c /docs/testing/user/userguide/10-yardstick-user-interface.rst | |
| parent | a0d32548802e608c2b0d984006221d439cb1a035 (diff) | |
| parent | 9c10763fedf5103bbd229648b17ee4a36d70e89e (diff) | |
Merge "[docs] Make heading levels consistent"
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 |