sandbox/code-block-directive/tools/pygments-enhanced-front-ends/rst2html-pygments

   1 #!/usr/bin/python
   2
   3 # :Author: David Goodger, the Pygments team, Guenter Milde
   4 # :Date: $Date: $
   5 # :Copyright: This module has been placed in the public domain.
   6
   7 # This is a merge of the docutils_ `rst2html` front end with an extension
   8 # suggestion taken from the pygments_ documentation.
   9
  10 """
  11 A front end to docutils, producing HTML with syntax colouring using pygments
  12 """
  13
  14 try:
  15     import locale
  16     locale.setlocale(locale.LC_ALL, '')
  17 except:
  18     pass
  19
  20 from docutils.core import publish_cmdline, default_description
  21
  22 description = ('Generates (X)HTML documents from standalone reStructuredText '
  23                'sources. Uses `pygments` to colorize the content of'
  24                '"code-block" directives. Needs an adapted stylesheet'
  25                + default_description)
  26
  27 # Define a new directive `code-block` that uses the `pygments` source
  28 # highlighter to render code in color.
  29 #
  30 # Code from the `pygments`_ documentation for `Using Pygments in ReST
  31 # documents`_.
  32
  33 from docutils import nodes
  34 from docutils.parsers.rst import directives
  35 from pygments import highlight
  36 from pygments.lexers import get_lexer_by_name
  37 from pygments.formatters import HtmlFormatter
  38
  39 pygments_formatter = HtmlFormatter()
  40
  41 def pygments_directive(name, arguments, options, content, lineno,
  42                        content_offset, block_text, state, state_machine):
  43     try:
  44         lexer = get_lexer_by_name(arguments[0])
  45     except ValueError:
  46         # no lexer found - use the text one instead of an exception
  47         lexer = get_lexer_by_name('text')
  48     parsed = highlight(u'\n'.join(content), lexer, pygments_formatter)
  49     return [nodes.raw('', parsed, format='html')]
  50 pygments_directive.arguments = (1, 0, 1)
  51 pygments_directive.content = 1
  52 directives.register_directive('code-block', pygments_directive)
  53
  54 # Call the docutils publisher to render the input as html::
  55
  56 publish_cmdline(writer_name='html', description=description)
  57
  58 # .. _doctutile: http://docutils.sf.net/
  59 # .. _pygments: http://pygments.org/
  60 # .. _Using Pygments in ReST documents: http://pygments.org/docs/rstdirective/