Commits

Sebastian Wiesner committed bd73af2

Initial import of the ansi extension

Comments (0)

Files changed (14)

 
 doxylink
    Matt Williams <matt@milliams.com>
+
+ansi:
+   Sebastian Wiesner <lunaryorn@googlemail.com>
 - epydoc: cross-reference eypdoc generated documentation
 - pyqt4: markup for PyQt4 signals
 - doxylink: Link to external Doxygen-generated HTML documentation
+- ansi: parse ANSI color sequences inside documents
 
 .. _aafigure: http://docutils.sourceforge.net/sandbox/aafigure/
 
+0.4 (May 21, 2010)
+==================
+
+- Initial release
+include README
+include LICENSE
+include CHANGES.*
+recursive-include sphinxcontrib/ *.css
+recursive-include doc/ *.rst *.py Makefile
+prune doc/_build/
+####################
+sphinxcontrib-ansi
+####################
+
+http://packages.python.org/sphinxcontrib-ansi
+
+A Sphinx_ extension, which turns ANSI color sequences in Sphinx documents
+into colored HTML output.
+
+
+Installation
+------------
+
+This extension can be installed from the Python Package Index::
+
+   pip install sphinx-contrib.ansi
+
+Alternatively, you can clone the sphinx-contrib_ repository from BitBucket,
+and install the extension directly from the repository::
+
+   hg clone http://bitbucket.org/birkenfeld/sphinx-contrib
+   cd sphinx-contrib/ansi
+   python setup.py install
+
+
+Usage
+-----
+
+Please refer to the documentation_ for further information.
+
+
+.. _`Sphinx`: http://sphinx.pocoo.org/latest
+.. _`sphinx-contrib`: http://bitbucket.org/birkenfeld/sphinx-contrib
+.. _documentation: http://packages.python.org/sphinxcontrib-ansi

ansi/doc/Makefile

+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+PAPER         =
+BUILDDIR      = _build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/sphinxcontrib-ansi.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/sphinxcontrib-ansi.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/sphinxcontrib-ansi"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/sphinxcontrib-ansi"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

ansi/doc/changes.rst

+#########
+Changelog
+#########
+
+.. include:: ../CHANGES.rst
+# -*- coding: utf-8 -*-
+#
+# sphinxcontrib-ansi documentation build configuration file, created by
+# sphinx-quickstart on Sun Jul 18 18:20:39 2010.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.intersphinx']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'sphinxcontrib-ansi'
+copyright = u'2010, Sebastian Wiesner'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.4'
+# The full version, including alpha/beta/rc tags.
+release = '0.4'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['_build']
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = ''
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'sphinxcontrib-ansidoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'sphinxcontrib-ansi.tex', u'sphinxcontrib-ansi Documentation',
+   u'Sebastian Wiesner', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'sphinxcontrib-ansi', u'sphinxcontrib-ansi Documentation',
+     [u'Sebastian Wiesner'], 1)
+]
+
+
+# Example configuration for intersphinx: refer to the Python standard library.
+intersphinx_mapping = {'http://docs.python.org/': None,
+                       'http://sphinx.pocoo.org/latest/': None,}
+
+
+def setup(app):
+    app.add_description_unit('confval', 'confval',
+                             'pair: %s; configuration value')

ansi/doc/index.rst

+.. highlight:: rest
+.. default-domain:: rst
+
+:py:mod:`lunar.sphinx.ext.ansi` -- Parse ANSI control sequences
+===============================================================
+
+.. py:module:: lunar.sphinx.ext.ansi
+   :synopsis:  Parse and interpret ANSI control sequences
+
+This extension for Sphinx_ 1.0 converts ANSI colour sequences to colored
+HTML output.  Use this extension to correctly include the output of command
+line tools, which use these control sequences to color their output (like
+``sphinx-build``, for instance).
+
+The extension is available under the terms of the BSD license, see LICENSE_
+for more information.
+
+
+Installation
+------------
+
+This extension can be installed from the Python Package Index::
+
+   pip install sphinx-contrib.ansi
+
+Alternatively, you can clone the sphinx-contrib_ repository from BitBucket,
+and install the extension directly from the repository::
+
+   hg clone http://bitbucket.org/birkenfeld/sphinx-contrib
+   cd sphinx-contrib/ansi
+   python setup.py install
+
+
+Usage
+-----
+
+To interpret ANSI colour codes, use the following directive:
+
+.. directive:: ansi-block
+
+   This directive interprets its content as literal block containing ANSI
+   control sequences for coloured output.
+
+   If the option ``string_escape`` is specified, the content of the
+   directive is decoded using the ``string_escape`` codec.  Thus you can
+   include Python escape sequences, and therefore use ``\x1b`` instead of
+   the real escape character.
+
+
+Appearance
+^^^^^^^^^^
+
+The appearance is controlled by :confval:`html_ansi_stylesheet`:
+
+.. confval:: html_ansi_stylesheet
+
+   The builtin stylesheet to use for ANSI color sequences.  As of now, the
+   following builtin stylesheets are provided:
+
+   - ``black-on-white.css``: Use dark colors on a white background.
+
+If you do not like the builtin stylesheets, set
+:confval:`html_ansi_stylesheet` to ``None`` and create your own stylesheet.
+This stylesheet must provide styles for the following CSS classes:
+
+- ``ansi-bold``: Bold text
+- ``ansi-underscore``: Underlined text
+- ``ansi-black``: Black colour
+- ``ansi-red``: Red colour
+- ``ansi-green``: Green colour
+- ``ansi-yellow``: Yellow colour
+- ``ansi-blue``: Blue colour
+- ``ansi-magenta``: Magenta colour
+- ``ansi-cyan``: Cyan colour
+- ``ansi-white``: White colour
+
+These classes can appear in different combinations, especially a colour
+combined with a text format.  You can therefore use a different colour, if
+the colour class is combined with a text format class.  See
+`black-on-white.css`_ for an example.
+
+Put this stylesheet somewhere in your :confval:`html_static_path` and make
+it known to sphinx by including the following code snippet in your
+``conf.py``:
+
+.. code-block:: python
+
+   def setup(app):
+       app.add_stylesheet('my_ansi_theme.css')
+
+
+Contribution
+------------
+
+Please contact the author or create an issue in the issue tracker of the
+sphinx-contrib_ repository, if you have found any bugs or miss some
+functionality (e.g. integration of some other issue tracker).  Patches are
+welcome!
+
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   changes.rst
+
+
+.. _`Sphinx`: http://sphinx.pocoo.org/latest
+.. _`sphinx-contrib`: http://bitbucket.org/birkenfeld/sphinx-contrib
+.. _`issue tracker`: http://bitbucket.org/birkenfeld/sphinx-contrib/issues
+.. _`black-on-white.css`: http://bitbucket.org/birkenfeld/sphinx-contrib/src/tip/ansi/sphinxcontrib/black-on-white.css
+.. _LICENSE: http://bitbucket.org/birkenfeld/sphinx-contrib/src/tip/LICENSE
+[egg_info]
+tag_build = dev
+tag_date = true
+
+[aliases]
+release = egg_info -RDb ''
+# -*- coding: utf-8 -*-
+
+from setuptools import setup, find_packages
+
+with open('README') as stream:
+    long_desc = stream.read()
+
+requires = ['Sphinx>=1.0b2']
+
+setup(
+    name='sphinxcontrib-ansi',
+    version='0.4',
+    url='http://bitbucket.org/birkenfeld/sphinx-contrib',
+    download_url='http://pypi.python.org/pypi/ansi',
+    license='BSD',
+    author='Sebastian Wiesner',
+    author_email='lunaryorn@googlemail.com',
+    description='Sphinx extension ansi',
+    long_description=long_desc,
+    zip_safe=False,
+    classifiers=[
+        'Development Status :: 4 - Beta',
+        'Environment :: Console',
+        'Environment :: Web Environment',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: BSD License',
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Topic :: Documentation',
+        'Topic :: Utilities',
+    ],
+    platforms='any',
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=requires,
+    namespace_packages=['sphinxcontrib'],
+)

ansi/sphinxcontrib/__init__.py

+# -*- coding: utf-8 -*-
+"""
+    sphinxcontrib
+    ~~~~~~~~~~~~~
+
+    This package is a namespace package that contains all extensions
+    distributed in the ``sphinx-contrib`` distribution.
+
+    :copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
+    :license: BSD, see LICENSE for details.
+"""
+
+__import__('pkg_resources').declare_namespace(__name__)
+

ansi/sphinxcontrib/ansi.py

+# -*- coding: utf-8 -*-
+# Copyright (c) 2010, Sebastian Wiesner <lunaryorn@googlemail.com>
+# All rights reserved.
+
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+
+# 1. Redistributions of source code must retain the above copyright notice,
+#    this list of conditions and the following disclaimer.
+# 2. Redistributions in binary form must reproduce the above copyright
+#    notice, this list of conditions and the following disclaimer in the
+#    documentation and/or other materials provided with the distribution.
+
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+
+"""
+    sphinxcontrib.ansi
+    ==================
+
+    This extension parses ANSI color codes in literal blocks.
+
+    .. moduleauthor::  Sebastian Wiesner  <lunaryorn@googlemail.com>
+"""
+
+
+import re
+from os import path
+
+from docutils import nodes
+from docutils.parsers import rst
+from docutils.parsers.rst.directives import flag
+from sphinx.util.osutil import copyfile
+from sphinx.util.console import bold
+
+
+class ansi_literal_block(nodes.literal_block):
+    """
+    Represent a literal block, that contains ANSI color codes.
+    """
+    pass
+
+
+#: the pattern to find ANSI color codes
+COLOR_PATTERN = re.compile('\x1b\\[([^m]+)m')
+
+#: map ANSI color codes to class names
+CODE_CLASS_MAP = {
+    1: 'bold',
+    4: 'underscore',
+    30: 'black',
+    31: 'red',
+    32: 'green',
+    33: 'yellow',
+    34: 'blue',
+    35: 'magenta',
+    36: 'cyan',
+    37: 'white',
+    }
+
+
+class ANSIColorParser(object):
+    """
+    Traverse a document, look for ansi_literal_block nodes, parse these
+    nodes, and replace them with literal blocks, containing proper child
+    nodes for ANSI color sequences.
+    """
+
+    def _finalize_pending_nodes(self):
+        """
+        Finalize all pending nodes.
+
+        Pending nodes will be append to the new nodes.
+        """
+        while self.pending_nodes:
+            self.new_nodes.append(self.pending_nodes.pop())
+
+    def _add_text(self, text):
+        """
+        If ``text`` is not empty, append a new Text node to the most recent
+        pending node, if there is any, or to the new nodes, if there are no
+        pending nodes.
+        """
+        if text:
+            if self.pending_nodes:
+                self.pending_nodes[-1].append(nodes.Text(text))
+            else:
+                self.new_nodes.append(nodes.Text(text))
+
+    def __call__(self, app, doctree, docname):
+        """
+        Extract and parse all ansi escapes in ansi_literal_block nodes.
+        """
+        for ansi_block in doctree.traverse(ansi_literal_block):
+            raw = ansi_block.rawsource
+            # create the "super" node, which contains to while block and all
+            # it sub nodes, and replace the old block with it
+            literal_node = nodes.literal_block()
+            literal_node['classes'].append('ansi-block')
+            ansi_block.replace_self(literal_node)
+
+            # this contains "pending" nodes.  A node representing an ANSI
+            # color is "pending", if it has not yet seen a reset
+            self.pending_nodes = []
+            # these are the nodes, that will finally be added to the
+            # literal_node
+            self.new_nodes = []
+            # this holds the end of the last regex match
+            last_end = 0
+            # iterate over all color codes
+            for match in COLOR_PATTERN.finditer(raw):
+                # add any text preceeding this match
+                head = raw[last_end:match.start()]
+                self._add_text(head)
+                # update the match end
+                last_end = match.end()
+                # get the single format codes
+                codes = [int(c) for c in match.group(1).split(';')]
+                if codes[-1] == 0:
+                    # the last code is a reset, so finalize all pending
+                    # nodes.
+                    self._finalize_pending_nodes()
+                else:
+                    # create a new color node
+                    code_node = nodes.inline()
+                    self.pending_nodes.append(code_node)
+                    # and set the classes for its colors
+                    for code in codes:
+                        code_node['classes'].append(
+                            'ansi-%s' % CODE_CLASS_MAP[code])
+            # add any trailing text
+            tail = raw[last_end:]
+            self._add_text(tail)
+            # move all pending nodes to new_nodes
+            self._finalize_pending_nodes()
+            # and add the new nodes to the block
+            literal_node.extend(self.new_nodes)
+
+
+def add_stylesheet(app):
+    if app.config.html_ansi_stylesheet:
+        app.add_stylesheet('ansi.css')
+
+
+def copy_stylesheet(app, exception):
+    if app.builder.name != 'html' or exception:
+        return
+    stylesheet = app.config.html_ansi_stylesheet
+    if stylesheet:
+        app.info(bold('Copying ansi stylesheet... '))
+        dest = path.join(app.builder.outdir, '_static', 'ansi.css')
+        source = path.abspath(path.dirname(__file__))
+        copyfile(path.join(source, stylesheet), dest)
+        app.info('done')
+
+
+class ANSIBlockDirective(rst.Directive):
+    """
+    This directive interprets its content as literal block with ANSI color
+    codes.
+
+    The content is decoded using ``string-escape`` to allow symbolic names
+    as \x1b being used instead of the real escape character.
+    """
+
+    has_content = True
+
+    option_spec = dict(string_escape=flag)
+
+    def run(self):
+        text = '\n'.join(self.content)
+        if 'string_escape' in self.options:
+            text = text.decode('string-escape')
+        return [ansi_literal_block(text, text)]
+
+
+def setup(app):
+    app.require_sphinx('1.0')
+    app.add_config_value('html_ansi_stylesheet', None, 'env')
+    app.add_directive('ansi-block', ANSIBlockDirective)
+    app.connect('builder-inited', add_stylesheet)
+    app.connect('build-finished', copy_stylesheet)
+    app.connect('doctree-resolved', ANSIColorParser())

ansi/sphinxcontrib/black-on-white.css

+.ansi-block {
+    background-color: #ffffff;
+    color: #000000;
+}
+
+.ansi-bold {
+    font-weight: bold;
+}
+
+.ansi-black {
+    color: #000000;
+}
+
+.ansi-red {
+    color: #b21717;
+}
+
+.ansi-green {
+    color: #17b217;
+}
+
+.ansi-yellow {
+    color: #b26717;
+}
+
+.ansi-blue {
+    color: #1717b2;
+}
+
+.ansi-magenta {
+    color: #b217b2;
+}
+
+.ansi-cyan {
+    color: #17b2b2;
+}
+
+.ansi-white {
+    color: #b2b2b2;
+}
+
+.ansi-black.ansi-bold {
+    color: #686868;
+}
+
+.ansi-red.ansi-bold {
+    color: #ff5454;
+}
+
+.ansi-green.ansi-bold {
+    color: #54ff54;
+}
+
+.ansi-yellow.ansi-bold {
+    color: #ffff54;
+}
+
+.ansi-blue.ansi-bold {
+    color: #5454ff;
+}
+
+.ansi-magenta.ansi-bold {
+    color: #ff54ff;
+}
+
+.ansi-cyan.ansi-bold {
+    color: #54ffff;
+}
+
+.ansi-white.ansi-bold {
+    color: #ffffff;
+}