Sha256: ec6040d4f9551aabbc58cd0eb6a0372f8b16c3c29e2e726d26e5b4cf1c0b0fc9

Contents?: true

Size: 873 Bytes

Versions: 48

Compression:

Stored size: 873 Bytes

Contents

.. -*- mode: rst -*-

================================
Using Pygments in ReST documents
================================

Many Python people use `ReST`_ for documentation their sourcecode, programs,
scripts et cetera. This also means that documentation often includes sourcecode
samples or snippets.

You can easily enable Pygments support for your ReST texts using a custom
directive -- this is also how this documentation displays source code.

From Pygments 0.9, the directive is shipped in the distribution as
`external/rst-directive.py`.  You can copy and adapt this code to your liking.

.. removed -- too confusing
   *Loosely related note:* The ReST lexer now recognizes ``.. sourcecode::`` and
   ``.. code::`` directives and highlights the contents in the specified language
   if the `handlecodeblocks` option is true.

.. _ReST: http://docutils.sf.net/rst.html

Version data entries

48 entries across 48 versions & 5 rubygems

Version Path
pygments.rb-0.2.6 vendor/pygments-main/docs/src/rstdirective.txt
pygments.rb-0.2.4 vendor/pygments-main/docs/src/rstdirective.txt
pygments.rb-0.2.3 vendor/pygments-main/docs/src/rstdirective.txt
pygments.rb-0.2.2 vendor/pygments-main/docs/src/rstdirective.txt
pygments.rb-0.2.1 vendor/pygments-main/docs/src/rstdirective.txt
pygments.rb-0.2.0 vendor/pygments-main/docs/src/rstdirective.txt
pygments.rb-0.1.3 vendor/Pygments-1.4/docs/src/rstdirective.txt
pygments.rb-0.1.2 vendor/Pygments-1.4/docs/src/rstdirective.txt