[OpenStack-docs] Writing RST Conventions

Anne Gentle anne at openstack.org
Tue Nov 11 14:21:33 UTC 2014


On Sat, Nov 8, 2014 at 12:51 PM, Andreas Jaeger <aj at suse.com> wrote:

> As discussed on Friday at the Docpod, I'd like to add RST conventions so
> that they can be used by others, for example infra-manual.
>
> Looking at
> https://wiki.openstack.org/wiki/Documentation/Docbook_conventions I
> propose to rename the page from "Docbook conventions" to "Markup
> conventions" and add for each Docbook example a corresponding RST example.
> I prefer this option (having Docbook and RST on the same page) since
> that also helps with moving from one to the other.
>
> Alternative would be a complete new page.
>
> Anybody with objections with moving forward with a single page?
>

Ah, good thinking. So on that page, can we provide a mapping of Docbook to
RST? Such as:
docbook=rst
command = :command:
filename = :file:
literal = :samp:
programlisting = ?
screen = ?



>
> Andreas
> --
>  Andreas Jaeger aj@{suse.com,opensuse.org} Twitter/Identica: jaegerandi
>   SUSE LINUX GmbH, Maxfeldstr. 5, 90409 Nürnberg, Germany
>    GF:Jeff Hawn,Jennifer Guild,Felix Imendörffer,HRB 21284 (AG Nürnberg)
>     GPG fingerprint = 93A3 365E CE47 B889 DF7F  FED1 389A 563C C272 A126
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20141111/e3106e52/attachment.html>


More information about the OpenStack-docs mailing list