About this guide¶
This page describes the conventions and tips on writing this guide itself.
The guide is written in reStructuredText (RST) markup syntax with Sphinx extensions. Most conventions follow those of the openstack-manuals project.
The followings are useful links when writing documents in RST.
Titles¶
The convention for heading levels is as follows:
=========
Heading 1
=========
Overline and underline with equal signs for heading 1 sections.
This level is reserved for the title in a document.
Heading 2
---------
Underline with dashes for heading 2 sections.
Heading 3
~~~~~~~~~
Underline with tildas for heading 3 sections.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.