File: cmake-annotate.rst

package info (click to toggle)
cmake-format 0.6.13-7
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,436 kB
  • sloc: python: 16,990; makefile: 14
file content (23 lines) | stat: -rw-r--r-- 773 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
.. _render_html:

==============
cmake-annotate
==============

The ``cmake-annotate`` frontend
program which can create semantic HTML documents from parsed listfiles.
This enables, in particular, semantic highlighting for your
code documentation.

.. literalinclude:: bits/annotate-usage.txt

``--format stub`` will output just the marked-up listfile content. The
markup is done as ``<span>`` elements with different css classes for each
parse-tree node or lexer token. The content is not encapsulated in any root
element (such as a ``<div>``). ``--format page`` will embed that content
into a full page with a root ``<html>`` and an embedded stylesheet.

The example listfile in the README, for example, can be rendered as:

.. raw:: html
   :file: example_rendered.html