Commits

stu...@yahoo.com  committed f319d91

Initial hack on gnuplut sphinx output to shoebot...

  • Participants
  • Parent commits 9789514

Comments (0)

Files changed (10)

File shoebot/LICENSE

+If not otherwise noted, the extensions in this package are licensed
+under the following license.
+
+Copyright (c) 2009 by the contributors (see AUTHORS file).
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+* 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.

File shoebot/MANIFEST.in

+include README
+include LICENSE
+include CHANGES.*

File shoebot/README

+.. -*- restructuredtext -*-
+
+=============================
+Gnuplot extension for Sphinx
+=============================
+
+:author: Vadim Gubergrits <vadim.gubergrits@gmail.com>
+
+
+About
+=====
+
+This extensions allows rendering of plots using the gnuplot_ language. 
+
+This extensions adds the ``gnuplot`` directive that will replace the gnuplot
+commands with the image of the plot. 
+
+
+Quick Example
+-------------
+
+This source::
+
+    .. gnuplot::
+        :title: The sine function
+
+        plot sin(x)
+
+is rendered as:
+
+.. gnuplot::
+    :title: The sine function
+
+    plot sin(x)
+
+
+
+Requirements
+------------
+
+* gnuplot_.
+
+Gnuplot_ should be installed and be in the system's path.
+
+
+Installing from sphinx-contrib checkout
+---------------------------------------
+
+Checkout sphinx-contrib::
+
+  $ hg clone https://bitbucket.org/birkenfeld/sphinx-contrib/
+
+Change into the gnuplot directory::
+
+  $ cd sphinx-contrib/gnuplot
+  
+Install the module::
+
+  $ python setup.py install
+
+
+
+Enabling the extension in Sphinx_
+---------------------------------
+
+Just add ``sphinxcontrib.gnuplot`` to the list of extensions in the ``conf.py``
+file. For example::
+
+    extensions = ['sphinxcontrib.gnuplot']
+
+
+Usage
+=====
+
+Options
+-------
+
+``size``: X,Y
+  Width and height of the resulting plot.
+
+``title``: <TITLE>
+  set the plot title to TITLE. Equivalent to "set title TITLE".
+
+
+Configuration
+-------------
+
+For now one optional configuration is added to Sphinx_. It can be set in
+``conf.py`` file:
+
+``gnuplot_fromat`` <dict>:
+  image format used for the different builders. ``latex`` and ``html`` fromats
+  are supported.
+
+  For example::
+
+    gnuplot_format = dict(latex='pdf', html='png')
+
+  These are the actual defaults.
+
+  
+
+Plotting data files
+-------------------
+
+Gnuplot is instructed to change its working directory to the document base
+directory. When referencing data files in gnuplot they must be relative to the
+document. 
+
+To provide a link to the data source you can use Sphinx_ standard ``download`` role::
+
+  .. gnuplot::
+
+     plot 'data.dat' using 1:2
+     
+  The source is :download:`here <data.dat>`.
+
+
+
+.. Links:
+.. _gnuplot: http://www.gnuplot.info/
+.. _Sphinx: http://sphinx.pocoo.org/
+

File shoebot/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 pickle json htmlhelp qthelp latex 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 "  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 "  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 "  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."
+
+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-gnuplot.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/sphinxcontrib-gnuplot.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) _build/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/sphinxcontrib-gnuplot"
+	@echo "# ln -s _build/devhelp $$HOME/.local/share/devhelp/sphinxcontrib-gnuplot"
+	@echo "# devhelp"
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make all-pdf' or \`make all-ps' in that directory to" \
+	      "run these through (pdf)latex."
+
+latexpdf: latex
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) _build/latex
+	@echo "Running LaTeX files through pdflatex..."
+	make -C _build/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in _build/latex."
+
+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."

File shoebot/doc/conf.py

+# -*- coding: utf-8 -*-
+#
+# sphinxcontrib-shoebot documentation build configuration file, created by
+# sphinx-quickstart on Mon Nov  9 23:18:51 2009.
+#
+# 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.append(os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = [
+  'sphinxcontrib.shoebot',
+]
+
+
+# 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-shoebot'
+copyright = u'2013, Stuart Axon, Vadim Gubergrits'
+
+# 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.1'
+# The full version, including alpha/beta/rc tags.
+release = '0.1'
+
+# 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 documents that shouldn't be included in the build.
+#unused_docs = []
+
+# List of directories, relative to source directory, that shouldn't be searched
+# for source files.
+exclude_trees = ['_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 = 'python'
+
+# 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.  Major themes that come with
+# Sphinx are currently 'default' and 'sphinxdoc'.
+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_use_modindex = 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-shoebotdoc'
+
+
+# -- 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-shoebot.tex', u'sphinxcontrib-shoebot Documentation',
+   u'Stuart Axon, Vadim Gubergrits', '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
+
+# 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_use_modindex = True

File shoebot/doc/index.rst

+
+.. include:: ../README
+
+
+
+License
+=======
+
+.. include:: ../LICENSE
+    :literal:
+

File shoebot/setup.cfg

+[egg_info]
+tag_build = dev
+tag_date = true
+
+[aliases]
+release = egg_info -RDb ''

File shoebot/setup.py

+# -*- coding: utf-8 -*-
+
+# Base off the gnuplot extension
+from setuptools import setup, find_packages
+
+long_desc = '''
+This package enables Sphinx documents to render graphics using shoebot.
+
+Example::
+  
+  .. shoebot::
+     
+     fill(0, 128, 128)
+     rect(0, 0, 40, 40)
+      
+'''
+
+requires = ['shoebot>=0.4a4']
+
+setup(
+    name='sphinxcontrib-shoebot',
+    version='0.1',
+    url='http://bitbucket.org/birkenfeld/sphinx-contrib',
+    download_url='http://pypi.python.org/pypi/sphinxcontrib-shoebot',
+    license='BSD',
+    author='Stuart Axon',
+    author_email='stuaxo2@yahoo.com',
+    description='Sphinx extension shoebot',
+    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'],
+)

File shoebot/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__)
+

File shoebot/sphinxcontrib/shoebot.py

+# -*- coding: utf-8 -*-
+"""
+    sphinxcontrib.shoebot
+    ~~~~~~~~~~~~~~~~~~~~~
+
+    Allow shoebot scripts be rendered as nice images
+    
+
+    See the README file for details.
+
+    :author: Stuart Axon <stuaxo2@yahoo.com>
+    :license: BSD, see LICENSE for details
+
+    Inspired by ``sphinxcontrib-aafig`` by Leandro Lucarella.
+"""
+
+import posixpath
+import subprocess
+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 import directives
+
+from sphinx.errors import SphinxError
+from sphinx.util import ensuredir, relative_uri
+from sphinx.util.compat import Directive
+
+
+
+DEFAULT_FORMATS = dict(html='png', latex='pdf', text=None)
+
+
+
+def get_hashid(text,options):
+    hashkey = text.encode('utf-8') + str(options)
+    hashid = sha(hashkey).hexdigest()
+    return hashid
+
+
+class ShoebotError(SphinxError):
+    category = 'shoebot error'
+
+
+class ShoebotDirective(directives.images.Image):
+    """
+    Directive that builds plots using shoebot.
+    """
+    has_content = True
+    required_arguments = 0
+    own_option_spec = dict(
+        still = str,
+        animation = str,
+
+    )
+
+    option_spec = directives.images.Image.option_spec.copy()
+    option_spec.update(own_option_spec)
+  
+    def run(self):
+        self.arguments = ['']
+        shoebot_options = dict([(k,v) for k,v in self.options.items() 
+                                  if k in self.own_option_spec])
+
+        (image_node,) = directives.images.Image.run(self)
+        if isinstance(image_node, nodes.system_message):
+            return [image_node]
+        text = '\n'.join(self.content)
+        image_node.shoebot = dict(text=text,options=shoebot_options)
+        return [image_node]
+
+
+def render_shoebot_images(app, doctree):
+    for img in doctree.traverse(nodes.image):
+        if not hasattr(img, 'shoebot'):
+            continue
+
+        text = img.shoebot['text']
+        options = img.shoebot['options']
+        try:
+            fname, outfn, hashid = render_shoebot(app, text, options)
+            img['uri'] = fname
+        except ShoebotError, exc:
+            app.builder.warn('shoebot error: ' + str(exc))
+            img.replace_self(nodes.literal_block(text, text))
+            continue
+
+
+def render_shoebot(app, text, options):
+    """
+    Render shoebot script to an image file.
+    """
+    format_map = DEFAULT_FORMATS.copy()
+    format_map.update(app.builder.config.shoebot_format)
+
+    hashid = get_hashid(text,options)
+    term = format_map[app.builder.format]
+    if app.builder.format == 'html':
+        fname = 'plot-%s.%s' % (hashid, term)
+        # 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('shoebot: the builder format %s '
+                'is not officially supported.' % app.builder.format)
+        fname = 'plot-%s.%s' % (hashid, term)
+        relfn = fname
+        outfn = path.join(app.builder.outdir, fname)
+
+    if path.isfile(outfn):
+        return relfn, outfn, hashid
+    
+    ensuredir(path.dirname(outfn))
+
+    docdir = (path.dirname(app.builder.env.docname))
+    try:
+        print options
+        if options['still']:
+            print ['sbot', '-o %s' % outfn, text]
+            subprocess.call(['sbot', '-o', '%s' % outfn, text])
+        #plot = Popen('shoebot -persist', shell=True, bufsize=64, stdin=PIPE)
+        #if docdir:
+        #    plot.stdin.write('cd "%s"\n' % docdir)
+        #plot.stdin.write("set terminal %s " % (term,))
+        #if 'size' in options:
+        #    plot.stdin.write("size %s\n" % options['size'])
+        #else:
+        #    plot.stdin.write("\n")
+        #if 'title' in options:
+        #    plot.stdin.write('set title "%s"\n' % options['title'])
+        #plot.stdin.write("set output '%s'\n" % (outfn,))
+        #plot.stdin.write("%s\n" % text)
+        #plot.stdin.write("\nquit\n")
+        #plot.stdin.flush()
+    except Exception, e:
+        raise ShoebotError(str(e))
+
+    return relfn, outfn, hashid
+
+
+def setup(app):
+    app.add_directive('shoebot', ShoebotDirective)
+    app.connect('doctree-read', render_shoebot_images)
+    app.add_config_value('shoebot_format', DEFAULT_FORMATS, 'html')