pygments.rb 0.5.4 → 0.6.0

data/vendor/pygments-main/doc/docs/authors.rst

@@ -0,0 +1,4 @@
+Full contributor list
+=====================
+
+.. include:: ../../AUTHORS

data/vendor/pygments-main/doc/docs/changelog.rst

@@ -0,0 +1 @@
+.. include:: ../../CHANGES

data/vendor/pygments-main/{docs/src/cmdline.txt → doc/docs/cmdline.rst}

@@ -4,8 +4,8 @@
 Command Line Interface
 ======================
 
-You can use Pygments from the shell, provided you installed the `pygmentize`
-script::
+You can use Pygments from the shell, provided you installed the
+:program:`pygmentize` script::
 
     $ pygmentize test.py
     print "Hello World"
@@ -28,7 +28,7 @@ written to stdout.
 The ``-f`` option selects a formatter (as with ``-l``, it can also be omitted
 if an output file name is given and has a supported extension).
 If no output file name is given and ``-f`` is omitted, the
-`TerminalFormatter` is used.
+:class:`.TerminalFormatter` is used.
 
 The above command could therefore also be given as::
 
@@ -82,14 +82,15 @@ Usage is as follows::
 generates a CSS style sheet (because you selected the HTML formatter) for
 the "colorful" style prepending a ".syntax" selector to all style rules.
 
-For an explanation what ``-a`` means for `a particular formatter`_, look for
-the `arg` argument for the formatter's `get_style_defs()` method.
+For an explanation what ``-a`` means for :doc:`a particular formatter
+<formatters>`, look for the `arg` argument for the formatter's
+:meth:`.get_style_defs()` method.
 
 
 Getting lexer names
 -------------------
 
-*New in Pygments 1.0.*
+.. versionadded:: 1.0
 
 The ``-N`` option guesses a lexer name for a given filename, so that ::
 
@@ -125,7 +126,7 @@ will print the help for the Python lexer, etc.
 A note on encodings
 -------------------
 
-*New in Pygments 0.9.*
+.. versionadded:: 0.9
 
 Pygments tries to be smart regarding encodings in the formatting process:
 
@@ -141,7 +142,4 @@ Pygments tries to be smart regarding encodings in the formatting process:
 
 * If you don't give an encoding and haven't given an output file (that means
   output is written to the console), the default encoding for lexer and
-  formatter is the terminal encoding (`sys.stdout.encoding`).
-
-
-.. _a particular formatter: formatters.txt
+  formatter is the terminal encoding (``sys.stdout.encoding``).

data/vendor/pygments-main/{docs/src/filterdevelopment.txt → doc/docs/filterdevelopment.rst}

@@ -4,7 +4,7 @@
 Write your own filter
 =====================
 
-*New in Pygments 0.7.*
+.. versionadded:: 0.7
 
 Writing own filters is very easy. All you have to do is to subclass
 the `Filter` class and override the `filter` method. Additionally a

data/vendor/pygments-main/{docs/src/filters.txt → doc/docs/filters.rst}

@@ -4,7 +4,7 @@
 Filters
 =======
 
-*New in Pygments 0.7.*
+.. versionadded:: 0.7
 
 You can filter token streams coming from lexers to improve or annotate the
 output. For example, you can highlight special words in comments, convert
@@ -31,12 +31,11 @@ To get a list of all registered filters by name, you can use the
 `get_all_filters()` function from the `pygments.filters` module that returns an
 iterable for all known filters.
 
-If you want to write your own filter, have a look at `Write your own filter`_.
-
-.. _Write your own filter: filterdevelopment.txt
+If you want to write your own filter, have a look at :doc:`Write your own filter
+<filterdevelopment>`.
 
 
 Builtin Filters
 ===============
 
-[builtin_filter_docs]
+.. pygmentsdoc:: filters

data/vendor/pygments-main/{docs/src/formatterdevelopment.txt → doc/docs/formatterdevelopment.rst}

@@ -4,7 +4,7 @@
 Write your own formatter
 ========================
 
-As well as creating `your own lexer <lexerdevelopment.txt>`_, writing a new
+As well as creating :doc:`your own lexer <lexerdevelopment>`, writing a new
 formatter for Pygments is easy and straightforward.
 
 A formatter is a class that is initialized with some keyword arguments (the

data/vendor/pygments-main/{docs/src/formatters.txt → doc/docs/formatters.rst}

@@ -12,8 +12,6 @@ Common options
 All formatters support these options:
 
 `encoding`
-    *New in Pygments 0.6.*
-
     If given, must be an encoding name (such as ``"utf-8"``). This will
     be used to convert the token strings (which are Unicode strings)
     to byte strings in the output (default: ``None``).
@@ -30,19 +28,21 @@ All formatters support these options:
     supports Unicode arguments to `write()`. Using a regular file object
     wouldn't work.
 
-`outencoding`
-    *New in Pygments 0.7.*
+    .. versionadded:: 0.6
 
+`outencoding`
     When using Pygments from the command line, any `encoding` option given is
     passed to the lexer and the formatter. This is sometimes not desirable,
     for example if you want to set the input encoding to ``"guess"``.
     Therefore, `outencoding` has been introduced which overrides `encoding`
     for the formatter if given.
 
+    .. versionadded:: 0.7
+
 
 Formatter classes
 =================
 
-All these classes are importable from `pygments.formatters`.
+All these classes are importable from :mod:`pygments.formatters`.
 
-[builtin_formatter_docs]
+.. pygmentsdoc:: formatters

data/vendor/pygments-main/doc/docs/index.rst

@@ -0,0 +1,66 @@
+Pygments documentation
+======================
+
+**Starting with Pygments**
+
+.. toctree::
+   :maxdepth: 1
+
+   ../download
+   quickstart
+   cmdline
+
+**Builtin components**
+
+.. toctree::
+   :maxdepth: 1
+
+   lexers
+   filters
+   formatters
+   styles
+
+**Reference**
+
+.. toctree::
+   :maxdepth: 1
+
+   unicode
+   tokens
+   api
+
+**Hacking for Pygments**
+
+.. toctree::
+   :maxdepth: 1
+
+   lexerdevelopment
+   formatterdevelopment
+   filterdevelopment
+   plugins
+
+**Hints and tricks**
+
+.. toctree::
+   :maxdepth: 1
+
+   rstdirective
+   moinmoin
+   java
+   integrate
+
+**About Pygments**
+              
+.. toctree::
+   :maxdepth: 1
+
+   changelog
+   authors
+
+
+If you find bugs or have suggestions for the documentation, please look
+:ref:`here <contribute>` for info on how to contact the team.
+
+.. XXX You can download an offline version of this documentation from the
+   :doc:`download page </download>`.
+

data/vendor/pygments-main/{docs/src/integrate.txt → doc/docs/integrate.rst}

@@ -23,8 +23,9 @@ Markdown
 --------
 
 Since Pygments 0.9, the distribution ships Markdown_ preprocessor sample code
-that uses Pygments to render source code in `external/markdown-processor.py`.
-You can copy and adapt it to your liking.
+that uses Pygments to render source code in
+:file:`external/markdown-processor.py`.  You can copy and adapt it to your
+liking.
 
 .. _Markdown: http://www.freewisdom.org/projects/python-markdown/
 
@@ -41,8 +42,3 @@ Bash completion
 
 The source distribution contains a file ``external/pygments.bashcomp`` that
 sets up completion for the ``pygmentize`` command in bash.
-
-Java
-----
-
-See the `Java quickstart <java.txt>`_ document.

data/vendor/pygments-main/{docs/src/lexerdevelopment.txt → doc/docs/lexerdevelopment.rst}

@@ -7,13 +7,13 @@ Write your own lexer
 If a lexer for your favorite language is missing in the Pygments package, you can
 easily write your own and extend Pygments.
 
-All you need can be found inside the `pygments.lexer` module. As you can read in
-the `API documentation <api.txt>`_, a lexer is a class that is initialized with
-some keyword arguments (the lexer options) and that provides a
-`get_tokens_unprocessed()` method which is given a string or unicode object with
-the data to parse.
+All you need can be found inside the :mod:`pygments.lexer` module. As you can
+read in the :doc:`API documentation <api>`, a lexer is a class that is
+initialized with some keyword arguments (the lexer options) and that provides a
+:meth:`.get_tokens_unprocessed()` method which is given a string or unicode
+object with the data to parse.
 
-The `get_tokens_unprocessed()` method must return an iterator or iterable
+The :meth:`.get_tokens_unprocessed()` method must return an iterator or iterable
 containing tuples in the form ``(index, token, value)``. Normally you don't need
 to do this since there are numerous base lexers you can subclass.
 
@@ -21,9 +21,9 @@ to do this since there are numerous base lexers you can subclass.
 RegexLexer
 ==========
 
-A very powerful (but quite easy to use) lexer is the `RegexLexer`. This lexer
-base class allows you to define lexing rules in terms of *regular expressions*
-for different *states*.
+A very powerful (but quite easy to use) lexer is the :class:`RegexLexer`. This
+lexer base class allows you to define lexing rules in terms of *regular
+expressions* for different *states*.
 
 States are groups of regular expressions that are matched against the input
 string at the *current position*. If one of these expressions matches, a
@@ -289,8 +289,9 @@ There are a few more things you can do with states:
   the closing ``*/``. Then, both states are popped from the stack again and
   lexing continues in the root state.
 
-  *New in Pygments 0.9:* The tuple can contain the special ``'#push'`` and
-  ``'#pop'`` (but not ``'#pop:n'``) directives.
+  .. versionadded:: 0.9
+     The tuple can contain the special ``'#push'`` and ``'#pop'`` (but not
+     ``'#pop:n'``) directives.
 
 
 - You can include the rules of a state in the definition of another.  This is
@@ -598,6 +599,4 @@ the ``get_tokens_unprocessed()`` method. The following lexer subclasses the
 
 The `PhpLexer` and `LuaLexer` use this method to resolve builtin functions.
 
-**Note** Do not confuse this with the `filter`_ system.
-
-.. _filter: filters.txt
+.. note:: Do not confuse this with the :doc:`filter <filters>` system.

data/vendor/pygments-main/{docs/src/lexers.txt → doc/docs/lexers.rst}

@@ -18,14 +18,13 @@ Currently, **all lexers** support these options:
 `ensurenl`
     Make sure that the input ends with a newline (default: ``True``).  This
     is required for some lexers that consume input linewise.
-    *New in Pygments 1.3.*
+
+    .. versionadded:: 1.3
 
 `tabsize`
     If given and greater than 0, expand tabs in the input (default: ``0``).
 
 `encoding`
-    *New in Pygments 0.6.*
-
     If given, must be an encoding name (such as ``"utf-8"``). This encoding
     will be used to convert the input string to Unicode (if it is not already
     a Unicode string). The default is ``"latin1"``.
@@ -35,18 +34,21 @@ Currently, **all lexers** support these options:
     `chardet library <http://chardet.feedparser.org/>`__ is used to
     guess the encoding of the input.
 
+    .. versionadded:: 0.6
+
 
 The "Short Names" field lists the identifiers that can be used with the
 `get_lexer_by_name()` function.
 
 These lexers are builtin and can be imported from `pygments.lexers`:
 
-[builtin_lexer_docs]
+.. pygmentsdoc:: lexers
+
 
 Iterating over all lexers
 -------------------------
 
-*New in Pygments 0.6.*
+.. versionadded:: 0.6
 
 To get all lexers (both the builtin and the plugin ones), you can
 use the `get_all_lexers()` function from the `pygments.lexers`

data/vendor/pygments-main/{docs/src/quickstart.txt → doc/docs/quickstart.rst}

@@ -58,8 +58,8 @@ can be produced by:
 
     print HtmlFormatter().get_style_defs('.highlight')
 
-The argument to `get_style_defs` is used as an additional CSS selector: the output
-may look like this:
+The argument to :func:`get_style_defs` is used as an additional CSS selector:
+the output may look like this:
 
 .. sourcecode:: css
 
@@ -71,9 +71,9 @@ may look like this:
 Options
 =======
 
-The `highlight()` function supports a fourth argument called `outfile`, it must be
-a file object if given. The formatted output will then be written to this file
-instead of being returned as a string.
+The :func:`highlight()` function supports a fourth argument called *outfile*, it
+must be a file object if given. The formatted output will then be written to
+this file instead of being returned as a string.
 
 Lexers and formatters both support options. They are given to them as keyword
 arguments either to the class or to the lookup method:
@@ -103,9 +103,9 @@ Important options include:
 
 
 For an overview of builtin lexers and formatters and their options, visit the
-`lexer <lexers.txt>`_ and `formatters <formatters.txt>`_ lists.
+:doc:`lexer <lexers>` and :doc:`formatters <formatters>` lists.
 
-For a documentation on filters, see `this page <filters.txt>`_.
+For a documentation on filters, see :doc:`this page <filters>`.
 
 
 Lexer and formatter lookup
@@ -131,9 +131,9 @@ one of the following methods:
 All these functions accept keyword arguments; they will be passed to the lexer
 as options.
 
-A similar API is available for formatters: use `get_formatter_by_name()` and
-`get_formatter_for_filename()` from the `pygments.formatters` module
-for this purpose.
+A similar API is available for formatters: use :func:`.get_formatter_by_name()`
+and :func:`.get_formatter_for_filename()` from the :mod:`pygments.formatters`
+module for this purpose.
 
 
 Guessing lexers
@@ -153,16 +153,17 @@ or some template tags), use these functions:
     >>> guess_lexer_for_filename('test.py', 'print "Hello World!"')
     <pygments.lexers.PythonLexer>
 
-`guess_lexer()` passes the given content to the lexer classes' `analyse_text()`
-method and returns the one for which it returns the highest number.
+:func:`.guess_lexer()` passes the given content to the lexer classes'
+:meth:`analyse_text()` method and returns the one for which it returns the
+highest number.
 
 All lexers have two different filename pattern lists: the primary and the
-secondary one. The `get_lexer_for_filename()` function only uses the primary
-list, whose entries are supposed to be unique among all lexers.
-`guess_lexer_for_filename()`, however, will first loop through all lexers and
-look at the primary and secondary filename patterns if the filename matches.
+secondary one. The :func:`.get_lexer_for_filename()` function only uses the
+primary list, whose entries are supposed to be unique among all lexers.
+:func:`.guess_lexer_for_filename()`, however, will first loop through all lexers
+and look at the primary and secondary filename patterns if the filename matches.
 If only one lexer matches, it is returned, else the guessing mechanism of
-`guess_lexer()` is used with the matching lexers.
+:func:`.guess_lexer()` is used with the matching lexers.
 
 As usual, keyword arguments to these functions are given to the created lexer
 as options.    
@@ -171,7 +172,8 @@ as options.
 Command line usage
 ==================
 
-You can use Pygments from the command line, using the `pygmentize` script::
+You can use Pygments from the command line, using the :program:`pygmentize`
+script::
 
     $ pygmentize test.py
 
@@ -199,4 +201,5 @@ it can be created with::
 
 where ``default`` is the style name.
 
-More options and tricks and be found in the `command line reference <cmdline.txt>`_.
+More options and tricks and be found in the :doc:`command line reference
+<cmdline>`.

data/vendor/pygments-main/{docs/src/styles.txt → doc/docs/styles.rst}

@@ -68,7 +68,7 @@ they can be used for a variety of formatters.)
 
 To make the style usable for Pygments, you must
 
-* either register it as a plugin (see `the plugin docs <plugins.txt>`_)
+* either register it as a plugin (see :doc:`the plugin docs <plugins>`)
 * or drop it into the `styles` subpackage of your Pygments distribution one style
   class per style, where the file name is the style name and the class name is
   `StylenameClass`. For example, if your style should be called
@@ -132,7 +132,7 @@ To get a list of known styles you can use this snippet:
 Getting a list of available styles
 ==================================
 
-*New in Pygments 0.6.*
+.. versionadded:: 0.6
 
 Because it could be that a plugin registered a style, there is
 a way to iterate over all styles:

data/vendor/pygments-main/{docs/src/tokens.txt → doc/docs/tokens.rst}

@@ -4,7 +4,9 @@
 Builtin Tokens
 ==============
 
-Inside the `pygments.token` module, there is a special object called `Token`
+.. module:: pygments.token
+
+In the :mod:`pygments.token` module, there is a special object called `Token`
 that is used to create token types.
 
 You can create a new token type by accessing an attribute of `Token`:
@@ -30,8 +32,8 @@ As of Pygments 0.7 you can also use the ``in`` operator to perform set tests:
     >>> Comment in Comment.Multi
     False
 
-This can be useful in `filters`_ and if you write lexers on your own without
-using the base lexers.
+This can be useful in :doc:`filters <filters>` and if you write lexers on your
+own without using the base lexers.
 
 You can also split a token type into a hierarchy, and get the parent of it:
 
@@ -55,7 +57,7 @@ For some tokens aliases are already defined:
     >>> String
     Token.Literal.String
 
-Inside the `pygments.token` module the following aliases are defined:
+Inside the :mod:`pygments.token` module the following aliases are defined:
 
 ============= ============================ ====================================
 `Text`        `Token.Text`                 for any type of text data
@@ -251,6 +253,9 @@ Literals
 `Number`
     Token type for any number literal.
 
+`Number.Bin`
+    Token type for binary literals (e.g. ``0b101010``).
+
 `Number.Float`
     Token type for float literals (e.g. ``42.0``).
 
@@ -280,7 +285,7 @@ Operators
 Punctuation
 ===========
 
-*New in Pygments 0.7.*
+.. versionadded:: 0.7
 
 `Punctuation`
     For any punctuation which is not an operator (e.g. ``[``, ``(``...)
@@ -345,5 +350,3 @@ highlight a programming language but a patch file.
 
 `Generic.Traceback`
     Marks the token value as a part of an error traceback.
-
-.. _filters: filters.txt