<div dir="ltr"><br><div class="gmail_extra"><br><div class="gmail_quote">On Fri, Sep 25, 2015 at 9:24 AM, Christian Berendt <span dir="ltr"><<a href="mailto:christian@berendt.io" target="_blank">christian@berendt.io</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex"><span>On 09/25/2015 03:26 AM, Matt Kassawara wrote:<br>
<blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
While updating the installation guide for Liberty, I found a conditional<br>
rendering problem. Our conventions state we use the heading "~~~" for<br>
sections and "---" for subsections. If I use this order under a<br>
conditional, the content disappears from the HTML output. If I flip the<br>
order, the content appears in the HTML output. I wrote a handful of test<br>
lines in my keystone patch [1] to provide an example of the problem. Any<br>
ideas?<br>
</blockquote>
<br></span>
According to <a href="http://docutils.sourceforge.net/docs/user/rst/quickstart.html" rel="noreferrer" target="_blank">http://docutils.sourceforge.net/docs/user/rst/quickstart.html</a> the correct order is:<br>
<br>
Chapter 1 Title<br>
===============<br>
<br>
Section 1.1 Title<br>
-----------------<br>
<br>
Subsection 1.1.1 Title<br>
~~~~~~~~~~~~~~~~~~~~~~<br>
<br>
Looks like our conventions are wrong.<br></blockquote><div><br></div><div>I've dug into this in the past, and as it turns out, we simply used what was given to us by pandoc when converting. Sphinx and RST have differing examples, neither is "correct" rather we just pick a convention and stick to it. Right now we are consistent with what pandoc gave us in our migration tooling.</div><div><br></div><div>Matt's issue was unrelated as it turns out, there was some extra indentation confusing the conditionals.</div><div><br></div><div>I'd prefer to stick with what we have for now. Only other consideration we might make would be to look at Python's conventions <a href="https://docs.python.org/devguide/documenting.html#sections">https://docs.python.org/devguide/documenting.html#sections</a>.</div><div><br></div><div><ul class="" style="color:rgb(62,67,73);font-family:Arial,sans-serif;font-size:14.4px"><li style="line-height:1.5em"><tt class="" style="color:rgb(34,34,34);font-size:1.1em;background-color:rgb(236,240,243)"><span class="">#</span></tt> with overline, for parts</li><li style="line-height:1.5em"><tt class="" style="color:rgb(34,34,34);font-size:1.1em;background-color:rgb(236,240,243)"><span class="">*</span></tt> with overline, for chapters</li><li style="line-height:1.5em"><tt class="" style="color:rgb(34,34,34);font-size:1.1em;background-color:rgb(236,240,243)"><span class="">=</span></tt>, for sections</li><li style="line-height:1.5em"><tt class="" style="color:rgb(34,34,34);font-size:1.1em;background-color:rgb(236,240,243)"><span class="">-</span></tt>, for subsections</li><li style="line-height:1.5em"><tt class="" style="color:rgb(34,34,34);font-size:1.1em;background-color:rgb(236,240,243)"><span class="">^</span></tt>, for subsubsections</li></ul></div><div>Thanks,</div><div><br></div><div>Anne</div><div> </div><blockquote class="gmail_quote" style="margin:0px 0px 0px 0.8ex;border-left-width:1px;border-left-color:rgb(204,204,204);border-left-style:solid;padding-left:1ex">
<br>
Christian.<br>
<br>
-- <br>
Christian Berendt<br>
Cloud Solution Architect<br>
Mail: <a href="mailto:berendt@b1-systems.de" target="_blank">berendt@b1-systems.de</a><br>
<br>
B1 Systems GmbH<br>
Osterfeldstraße 7 / 85088 Vohburg / <a href="http://www.b1-systems.de" rel="noreferrer" target="_blank">http://www.b1-systems.de</a><br>
GF: Ralph Dehner / Unternehmenssitz: Vohburg / AG: Ingolstadt,HRB 3537<br>
<br>
_______________________________________________<br>
OpenStack-docs mailing list<br>
<a href="mailto:OpenStack-docs@lists.openstack.org" target="_blank">OpenStack-docs@lists.openstack.org</a><br>
<a href="http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs" rel="noreferrer" target="_blank">http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs</a><br>
</blockquote></div><br><br clear="all"><div><br></div>-- <br><div><div dir="ltr"><div>Anne Gentle</div><div>Rackspace</div><div>Principal Engineer</div><div><a href="http://www.justwriteclick.com" target="_blank">www.justwriteclick.com</a></div></div></div>
</div></div>