Add forkme on gh tag. Try to update to latest sphinx by vendorizing sphinxcontrib-aafig

tony · tony · commit 3547548522c5 · 2015-05-19T21:28:37.000-05:00
diff --git a/doc/_ext/__init__.py b/doc/_ext/__init__.py
diff --git a/doc/_ext/aafig.py b/doc/_ext/aafig.py
@@ -0,0 +1,211 @@
+# -*- coding: utf-8 -*-
+"""
+    sphinxcontrib.aafig
+    ~~~~~~~~~~~~~~~~~~~
+
+    Allow embeded ASCII art to be rendered as nice looking images
+    using the aafigure reStructuredText extension.
+
+    See the README file for details.
+
+    :author: Leandro Lucarella <llucax@gmail.com>
+    :license: BOLA, see LICENSE for details
+"""
+
+import posixpath
+from os import path
+try:
+    from hashlib import sha1 as sha
+except ImportError:
+    from sha import sha
+
+from docutils import nodes
+from docutils.parsers.rst.directives import images, nonnegative_int, flag
+
+from sphinx.errors import SphinxError
+from sphinx.util import ensuredir, relative_uri
+from sphinx.util.compat import Directive
+
+try:
+    import aafigure
+except ImportError:
+    aafigure = None
+
+
+DEFAULT_FORMATS = dict(html='svg', latex='pdf', text=None)
+
+
+def merge_dict(dst, src):
+    for (k, v) in src.items():
+        if k not in dst:
+            dst[k] = v
+    return dst
+
+
+def get_basename(text, options, prefix='aafig'):
+    options = options.copy()
+    if 'format' in options:
+        del options['format']
+    hashkey = text.encode('utf-8') + str(options)
+    id = sha(hashkey).hexdigest()
+    return '%s-%s' % (prefix, id)
+
+
+class AafigError(SphinxError):
+    category = 'aafig error'
+
+
+class AafigDirective(images.Image):
+    """
+    Directive to insert an ASCII art figure to be rendered by aafigure.
+    """
+    has_content = True
+    required_arguments = 0
+    own_option_spec = dict(
+        line_width   = float,
+        background   = str,
+        foreground   = str,
+        fill         = str,
+        aspect       = nonnegative_int,
+        textual      = flag,
+        proportional = flag,
+    )
+    option_spec = images.Image.option_spec.copy()
+    option_spec.update(own_option_spec)
+
+    def run(self):
+        aafig_options = dict()
+        image_attrs = dict()
+        own_options_keys = self.own_option_spec.keys() + ['scale']
+        for (k, v) in self.options.items():
+            if k in own_options_keys:
+                # convert flags to booleans
+                if v is None:
+                    v = True
+                # convert percentage to float
+                if k == 'scale' or k == 'aspect':
+                    v = float(v) / 100.0
+                aafig_options[k] = v
+                del self.options[k]
+        self.arguments = ['']
+        (image_node,) = images.Image.run(self)
+        if isinstance(image_node, nodes.system_message):
+            return [image_node]
+        text = '\n'.join(self.content)
+	image_node.aafig = dict(options = aafig_options, text = text)
+        return [image_node]
+
+
+def render_aafig_images(app, doctree):
+    format_map = app.builder.config.aafig_format
+    merge_dict(format_map, DEFAULT_FORMATS)
+    if aafigure is None:
+        app.builder.warn('aafigure module not installed, ASCII art images '
+                'will be redered as literal text')
+    for img in doctree.traverse(nodes.image):
+        if not hasattr(img, 'aafig'):
+            continue
+        if aafigure is None:
+            img.replace_self(nodes.literal_block(text, text))
+            continue
+        options = img.aafig['options']
+        text = img.aafig['text']
+        format = app.builder.format
+        merge_dict(options, app.builder.config.aafig_default_options)
+        if format in format_map:
+            options['format'] = format_map[format]
+        else:
+            app.builder.warn('unsupported builder format "%s", please '
+                    'add a custom entry in aafig_format config option '
+                    'for this builder' % format)
+            img.replace_self(nodes.literal_block(text, text))
+            continue
+        if options['format'] is None:
+            img.replace_self(nodes.literal_block(text, text))
+            continue
+        try:
+            fname, outfn, id, extra = render_aafigure(app, text, options)
+        except AafigError, exc:
+            app.builder.warn('aafigure error: ' + str(exc))
+            img.replace_self(nodes.literal_block(text, text))
+            continue
+        img['uri'] = fname
+        # FIXME: find some way to avoid this hack in aafigure
+        if extra:
+            (width, height) = [x.split('"')[1] for x in extra.split()]
+            if not img.has_key('width'):
+                img['width'] = width
+            if not img.has_key('height'):
+                img['height'] = height
+
+
+def render_aafigure(app, text, options):
+    """
+    Render an ASCII art figure into the requested format output file.
+    """
+
+    if aafigure is None:
+        raise AafigError('aafigure module not installed')
+
+    fname = get_basename(text, options)
+    fname = '%s.%s' % (get_basename(text, options), options['format'])
+    if app.builder.format == 'html':
+        # HTML
+        imgpath = relative_uri(app.builder.env.docname, '_images')
+        relfn = posixpath.join(imgpath, fname)
+        outfn = path.join(app.builder.outdir, '_images', fname)
+    else:
+        # Non-HTML
+        if app.builder.format != 'latex':
+            app.builder.warn('aafig: the builder format %s is not officially '
+                    'supported, aafigure images could not work. Please report '
+                    'problems and working builder to avoid this warning in '
+                    'the future' % app.builder.format)
+        relfn = fname
+        outfn = path.join(app.builder.outdir, fname)
+    metadata_fname = '%s.aafig' % outfn
+
+    try:
+        if path.isfile(outfn):
+            extra = None
+            if options['format'].lower() == 'svg':
+                f = None
+                try:
+                    try:
+                        f = file(metadata_fname, 'r')
+                        extra = f.read()
+                    except:
+                        raise AafigError()
+                finally:
+                    if f is not None:
+                        f.close()
+            return relfn, outfn, id, extra
+    except AafigError:
+        pass
+
+    ensuredir(path.dirname(outfn))
+
+    try:
+        (visitor, output) = aafigure.render(text, outfn, options)
+	output.close()
+    except aafigure.UnsupportedFormatError, e:
+        raise AafigError(str(e))
+
+    extra = None
+    if options['format'].lower() == 'svg':
+        extra = visitor.get_size_attrs()
+        f = file(metadata_fname, 'w')
+        f.write(extra)
+        f.close()
+
+    return relfn, outfn, id, extra
+
+
+def setup(app):
+    app.add_directive('aafig', AafigDirective)
+    app.connect('doctree-read', render_aafig_images)
+    app.add_config_value('aafig_format', DEFAULT_FORMATS, 'html')
+    app.add_config_value('aafig_default_options', dict(), 'html')
+
+
+# vim: set expandtab shiftwidth=4 softtabstop=4 :
diff --git a/doc/_templates/page.html b/doc/_templates/page.html
@@ -0,0 +1,9 @@
+{% extends "!page.html" %}
+{% block footer -%}
+{{ super() }}
+<a href="https://github.com/tony/tmuxp">
+  <img style="position: absolute; top: 0; right: 0; border: 0;"
+  src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png"
+  alt="Fork me on GitHub">
+</a>
+{%- endblock %}
diff --git a/doc/conf.py b/doc/conf.py
@@ -24,18 +24,14 @@
 # This lets us ensure that the source package is imported, and that its
 # version is used.
 sys.path.insert(0, project_root)
+sys.path.append(os.path.abspath(os.path.join(os.path.dirname(__file__), "_ext")))
 
 # package data
 about = {}
 with open("../tmuxp/__about__.py") as fp:
     exec(fp.read(), about)
 
 
-# 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 -----------------------------------------------------
 
 
@@ -47,8 +43,8 @@
 extensions = ['sphinx.ext.autodoc',
               'sphinx.ext.intersphinx',
               'sphinx.ext.todo',
-              'sphinxcontrib.aafig',
               'sphinxarg.ext',
+              'aafig',
               ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -129,7 +125,12 @@
 if on_rtd:
     html_theme = 'default'
 else:
-    html_theme = 'pyramid'
+    try:
+        import sphinx_rtd_theme
+        html_theme = "sphinx_rtd_theme"
+        html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+    except ImportError:
+        html_theme = 'pyramid'
 
 #html_theme = 'sphinx_rtd_theme'
 
diff --git a/doc/requirements.pip b/doc/requirements.pip
@@ -1,6 +1,6 @@
 -r ../requirements.pip
 docutils==0.12
-sphinx<1.2.1
+sphinx
 reportlab
-sphinxcontrib-aafig
 sphinx-argparse
+sphinx-rtd-theme
