[OpenStack-docs] Deprecation of custom semantic markup
Christian Berendt
christian at berendt.io
Mon Sep 28 09:50:13 UTC 2015
On 09/26/2015 01:30 PM, Sutton, Harry (HP Converged Systems & Solutions
ERT) wrote:
> Hmm, isn't that the reverse of what Christian just posted? (underline
> "-" for sections, and underline "~" for subsections)
Yes. But I used
http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html as
reference.
http://sphinx-doc.org/rest.html documents the following markups:
---snip---
# with overline, for parts
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
", for paragraphs
---snap---
When introducing a reference document (we should do this) we should use
http://sphinx-doc.org/rest.html because we want to use RST with Sphinx.
+1 on lesser semantic markup.
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