[OpenStack-docs] Usage of custom RST directives

Anne Gentle annegentle at justwriteclick.com
Wed Dec 2 14:01:26 UTC 2015


On Wed, Dec 2, 2015 at 4:31 AM, Christian Berendt <christian at berendt.io>
wrote:

> Hello everybody.
>
> While reviewing a review request for the new config-rst-guide I saw the
> usage of the RST directive "remote-code-block". I never saw this directive
> before and after searching for the definition I only found
> https://github.com/openstack/openstack-manuals/blob/master/doc/config-ref-rst/source/ext/remote.py#L19
> .
>
> At the moment I am not sure if I like it or not. But I think the usage of
> custom RST directives should be discussed on the list and if we decide to
> use custom RST directives they should be documented in the contributor
> guide.
>

Thanks for bringing it up.

For the API guides, we will need to heavily use RST directives, and I'm
documenting those now. So yes, in my opinion we simply have to extend if
there's not another way to accomplish certain goals.

Thanks,
Anne


>
> 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
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>



-- 
Anne Gentle
Rackspace
Principal Engineer
www.justwriteclick.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20151202/20a65137/attachment-0001.html>


More information about the OpenStack-docs mailing list