[cmake-developers] Documentation style guide

[Brad King]

On 02/03/2014 07:19 PM, Stephen Kelly wrote:
> Brad King wrote:
>>> 2)
>>>   Signatures are introduced in prose after their appearance.
> What seems to be needed is a transition:
> 
>  http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#transitions

Yes, using "---------------------------------------------------------------------"
looks good in the source form, html, man, and cmRST output.  We should recommend
that they be used sparingly though because lots of horizontal dividers with only
a small amount of text in between looks noisy.

> I'd prefer to recommend two in that case. It's the same as cmake c++ code, 

Okay.

> :ref:`IMPORTED library targets <Imported Targets>`.
[snip]
> I think it's fine

Yes.

Thanks,
-Brad