Konstantin Lopuhin avatar Konstantin Lopuhin committed 60f9707 Draft

documentation

Comments (0)

Files changed (1)

pygments/formatters/html.py

     A list of lines can be specified using the `hl_lines` option to make these
     lines highlighted (as of Pygments 0.11).
 
+    You can also visuale line profiling information with a heatmap using
+    `heatmap` option.
+
     With the `full` option, a complete HTML 4 document is output, including
     the style definitions inside a ``<style>`` tag, or in a separate file if
     the `cssfile` option is given.
         Specify a list of lines to be highlighted.  *New in Pygments 0.11.*
 
     `heatmap`
-        TODO
+        Specify percentage of time spent in lines of included code,
+        to get a heatmap display with percentage number on the right.
+        Useful for visualizing profiling information from
+        statprof/lineprof/etc.
+        First goes the line where the function starts, and then 
+        a list of line:percentage paris::
+
+            30 32:40.83 30:11.73 31:8.19
 
     `linenostart`
         The line number for the first line (default: ``1``).
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.