[OpenStack-docs] RST conditional rendering problem

Christian Berendt christian at berendt.io
Fri Sep 25 14:24:53 UTC 2015


On 09/25/2015 03:26 AM, Matt Kassawara wrote:
> While updating the installation guide for Liberty, I found a conditional
> rendering problem. Our conventions state we use the heading "~~~" for
> sections and "---" for subsections. If I use this order under a
> conditional, the content disappears from the HTML output. If I flip the
> order, the content appears in the HTML output. I wrote a handful of test
> lines in my keystone patch [1] to provide an example of the problem. Any
> ideas?

According to 
http://docutils.sourceforge.net/docs/user/rst/quickstart.html the 
correct order is:

Chapter 1 Title
===============

Section 1.1 Title
-----------------

Subsection 1.1.1 Title
~~~~~~~~~~~~~~~~~~~~~~

Looks like our conventions are wrong.

Christian.

-- 
Christian Berendt
Cloud Solution Architect
Mail: berendt at b1-systems.de

B1 Systems GmbH
Osterfeldstraße 7 / 85088 Vohburg / http://www.b1-systems.de
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537



More information about the OpenStack-docs mailing list