Fwd: [PATHC] [DOCS] LangRef: Insert numerous .. code-block:: llvm to colorize examples

Mikael Lyngvig mikael at lyngvig.org
Sun Nov 24 21:07:54 PST 2013


Ouch, I just noticed what my "Syntax::" changes did to the table of
contents.  Not pretty!  Here's an updated patch that only adds "..
code-block:: llvm" wherever it seemed reasonable.



---------- Forwarded message ----------
From: Mikael Lyngvig <mikael at lyngvig.org>
Date: 2013/11/25
Subject: [PATHC] [DOCS] LangRef: Insert numerous .. code-block:: llvm to
colorize examples
To: LLVM-commits <llvm-commits at cs.uiuc.edu>


Please ignore this commit if the existing "::" blocks (which makes Sphinx
not colorize the examples) are intentional.

I've gone through and changed a number of cases like this:

::

   [llvm snippet]

into:

.. code-block:: llvm

   [llvm snippet]

Also, I changed three occurences of:

   Syntax::

into:

   Syntax:
   ^^^^^^^^

So that the document becomes more consistent in its use of sections for
syntax examples.

The net effect is that the document becomes more "vivid" or "lively" to
read in its HTML form.


-- Mikael
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20131125/c5008b6d/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: LangRef.rst.patch
Type: application/octet-stream
Size: 29236 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20131125/c5008b6d/attachment.obj>


More information about the llvm-commits mailing list