openstack/openstack-manuals
Code Issues Proposed changes

[contrib] Update heading markup to follow what most projects do

Browse Source 
Based on the discussion from:
https://review.openstack.org/#/c/579177/

Make the convention consistent with what other OpenStack projects
do and with recommendations from:
http://docutils.sourceforge.net/docs/user/rst/quickstart.html#sections

Change-Id: I33628180430357dbdc14b7775aa3a5307bb93291
This commit is contained in:
Petr Kovar
2018-07-17 15:44:53 +02:00
parent 77efa0615d
commit 6f21c41cc6
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
doc/doc-contrib-guide/source/rst-conv/titles.rst
View File

@@ -9,9 +9,9 @@ levels within one file using the following non-alphanumeric characters:
* **Heading 1** - underline and overline with equal signs;
* **Heading 2** - underline with tildes;
* **Heading 2** - underline with dashes;
* **Heading 3** - underline with dashes.
* **Heading 3** - underline with tildes.
**Input**
@@ -26,7 +26,7 @@ levels within one file using the following non-alphanumeric characters:
Can include several focused Heading-2-sections.
Heading 2
~~~~~~~~~
---------
Body of the second level section that gives detailed explanation of one
of the aspects of the subject. Can include several Heading-3-sections.
@@ -36,7 +36,7 @@ levels within one file using the following non-alphanumeric characters:
For example, "Associate floating IP addresses".
Heading 3
---------
~~~~~~~~~
Body of the third level section.
It includes very specific content, and occurs mainly in guides containing