guard-mthaml 0.1.0

data/vendor/mthaml/mthaml/docs/_static/mthaml.css

@@ -0,0 +1,30 @@
+
+@import "default.css";
+
+.container.code-cols ul.simple em {
+    font-size: small;
+}
+
+.container.code-cols .highlight-html\+jinja, .container.code-cols .highlight-haml {
+    width: 46%;
+    margin: 0 2% 0 0;
+    display: inline-block;
+    vertical-align: top;
+}
+
+.container.code-cols .highlight-html\+jinja:before {
+    content: "Twig";
+    font-size: small;
+    font-style: italic;
+}
+
+.container.code-cols .highlight-haml:before {
+    content: "Haml";
+    font-size: small;
+    font-style: italic;
+}
+
+.container.code-cols pre {
+    margin-top: 0;
+}
+

data/vendor/mthaml/mthaml/docs/_theme/mthaml/theme.conf

@@ -0,0 +1,4 @@
+[theme]
+inherit = default
+stylesheet = mthaml.css
+pygments_style = sphinx

data/vendor/mthaml/mthaml/docs/conf.py

@@ -0,0 +1,242 @@
+# -*- coding: utf-8 -*-
+#
+# MtHaml documentation build configuration file, created by
+# sphinx-quickstart on Fri Sep 13 21:55:33 2013.
+#
+# 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('_exts'))
+
+# -- 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 = []
+
+# 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'MtHaml'
+copyright = u'2013, MtHaml Authors'
+
+# 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 = '1.0'
+# The full version, including alpha/beta/rc tags.
+release = '1.0'
+
+# 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 = 'mthaml'
+
+# 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 = ['_theme']
+
+# 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 = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'MtHamldoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'MtHaml.tex', u'MtHaml Documentation',
+   u'Arnaud Le Blanc', '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
+
+# 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', 'mthaml', u'MtHaml Documentation',
+     [u'MtHaml Authors'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'MtHaml', u'MtHaml Documentation',
+   u'MtHaml Authors', 'MtHaml', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'

data/vendor/mthaml/mthaml/docs/index.rst

@@ -0,0 +1,18 @@
+
+Welcome to MtHaml's documentation!
+==================================
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

data/vendor/mthaml/mthaml/docs/twig-syntax.rst

@@ -0,0 +1,274 @@
+
+MtHaml/Twig syntax
+==================
+
+Haml is a short syntax for Html, coupled with a template engine. In
+MtHaml/Twig, the template engine is Twig.
+
+Quick introduction to HAML
+--------------------------
+
+.. container:: code-cols
+
+    .. code-block:: html+jinja
+
+        <strong>{{ item.title }}</strong>
+
+    .. code-block:: haml
+
+        %strong= item.title
+
+In Haml, we start a tag by using the percent character followed by the name
+of the tag. This works for ``%div``, ``%html``, ``%li``, or any other tag.
+
+The ``=`` after the tag name tells Haml that what follows is Twig code that
+should be printed.
+
+Adding attributes
+~~~~~~~~~~~~~~~~~
+
+.. container:: code-cols
+
+    .. code-block:: html+jinja
+
+        <strong class="code" id="message">Hello, World!</strong>
+
+    .. code-block:: haml
+
+        %strong(class="code" id="message") Hello, World!
+
+The syntax for attributes is very much like HTML's.
+
+Since ``class`` and ``id`` attributes are very common, there is a short
+notation for them, using CSS syntax:
+
+.. container:: code-cols
+
+    .. code-block:: html+jinja
+
+        <strong class="code" id="message">Hello, World!</strong>
+
+    .. code-block:: haml
+
+        %strong.code#message Hello, World!
+
+Haml also allows to omit the tag name, in which case it defaults to ``%div``.
+
+.. container:: code-cols
+
+    .. code-block:: html+jinja
+
+        <div class='content'>Hello, World!</div>
+
+    .. code-block:: haml
+
+        .message Hello, World!
+
+Examples with nesting
+~~~~~~~~~~~~~~~~~~~~~
+
+.. container:: code-cols
+
+    .. code-block:: html+jinja
+
+        <div class='item' id='item<%= item.id %>'>
+            {{ item.body }}
+        </div>
+
+
+    .. code-block:: haml
+
+        .item(id="item#{item.id}")
+            = item.body
+
+White spaces, or more specifically indentation, is significant in Haml. This allows Haml to close tags automatically:
+
+ - when there is inline content, the tag is closed just after the content,
+   on the same line
+ - otherwise the tag is closed as soon as the indentation level decreases
+   to the level of the opening tag
+ - there are also special rules for auto-closing tags like ``%img`` or
+   ``%meta``.
+
+.. container:: code-cols
+
+    .. code-block:: html+jinja
+
+        <div id='content'>
+            <div class='left column'>
+                <h2>Welcome to our site!</h2>
+                <p>{{ information }}</p>
+            </div>
+            <div class="right column">
+                {% include "sidebar.twig" %}
+            </div>
+        </div>
+
+    .. code-block:: haml
+
+        #content
+            .left.column
+                %h2 Welcome to our site!
+                %p= information
+            .right.column
+                - include "sidebar.twig"
+
+.. note::
+
+    See the Haml reference at http://haml.info/docs/yardoc/file.REFERENCE.html#plain_text
+
+Haml to Twig
+~~~~~~~~~~~~
+
+MtHaml works by converting Haml syntax to plain Twig templates, which Twig
+then executes.
+
+The easiest way to understand how to write Haml/Twig templates is to understand
+how the templates are converted to Twig.
+
+Printing
+########
+
+The most common way to print something in Haml is by starting a line with the ``=`` character (or immediately following a tag declaration). Everything after the ``=`` is expected to be a Twig expression, and will be converted to Twig's double curly syntax:
+
+.. container:: code-cols
+
+    .. code-block:: haml
+
+        %p.para= some.twig()|expression
+
+    .. code-block:: html+jinja
+
+        <p class="para">{{ some.twig()|expression }}</p>
+
+You can effectively use any valid Twig expression here; including but not limited to functions, filters, macros, array element access.
+
+There a few other ways to print something in Haml, for instance by using string interpolations syntax:
+
+.. container:: code-cols
+
+    .. code-block:: haml
+
+        %span Hello #{ name }
+
+    .. code-block:: html+jinja
+
+        <span>Hello {{ name }}</span>
+
+And a few other places, like in attribute values:
+
+.. container:: code-cols
+
+    .. code-block:: haml
+
+        %span(id=any_valid_twig|syntax)
+
+    .. code-block:: html+jinja
+
+        <span id={{ any_valid_twig|syntax }}></span>
+
+MtHaml will accept anything in attribute values, as long as parentheses, curly braces, square brackets, quotes, and double quotes are balanced.
+
+
+Control structures, or Twig tags
+################################
+
+Now what about code we don't want to print?
+
+In Haml, executing code we don't want to print is done by starting a line with the ``-`` character (maybe preceeded by indentation).
+
+Everything after the ``-`` is expected to be a Twig tag, and will be converted to Twig's curly percent syntax.
+
+.. container:: code-cols
+
+    .. code-block:: haml
+
+        %p
+            - if some.condition|default(0) > 1 or foo in bar
+                This is a control structure
+
+        %ul#a-list
+            - for value in some.array
+                %li.list-item= value
+
+    .. code-block:: html+jinja
+
+        <p>
+            {% if some.condition|default(0) > 1 or foo in bar %}
+                This is a control structure
+            {% endif %}
+        </p>
+
+        <ul id="a-list">
+            {% for value in some.array %}
+                <li class="list-item">{{ value }}</li>
+            {% endfor %}
+        </ul>
+
+Here too, you can use any valid Twig `tag <http://twig.sensiolabs.org/doc/tags/index.html>`_. For instance, in the `if <http://twig.sensiolabs.org/doc/tags/if.html>`_ tag, you can use any twig `expression <http://twig.sensiolabs.org/doc/templates.html#expressions>`_, including but not limited to `filters <http://twig.sensiolabs.org/doc/filters/index.html>`_, `tests <http://twig.sensiolabs.org/doc/tests/index.html>`_, `operators <http://twig.sensiolabs.org/doc/templates.html#comparisons>`_.
+
+End tags are added automatically if the tag is followed by indented lines. Otherwise, no end tag is added. This simple rule allows MtHaml to support every possible Twig tag, without knowing the meaning of tags.
+
+Example with blocks:
+
+.. container:: code-cols
+
+    .. code-block:: haml
+
+        - extends "layout.twig"
+
+        - block title "this is an inline block"
+
+        - block body
+            .content
+                %h1 Title
+                This block has contents
+
+    .. code-block:: html+jinja
+
+        {% extends "layout.twig" %}
+
+        {% block title "this is an inline block" %}
+
+        {% block body %}
+            <div class="content">
+                <h1>Title</h1>
+                This block has contents
+            </div>
+        {% endblock %}
+
+Example with macros:
+
+.. container:: code-cols
+
+    .. code-block:: html+jinja
+
+        {% macro input_text(name, value) %}
+            <input type="text" name="{{ name }}" value="{{ value }} />
+        {% endmacro %}
+
+        {% import _self as forms %}
+
+        {{ forms.input_text("foo", "bar") }}
+
+    .. code-block:: haml
+
+        - macro input_text(name, value)
+            %input(type="text" name=name value=value)
+
+
+        - import _self as forms
+
+        = forms.input_text("foo", "bar")
+
+And every tag you want, even custom tags.
+
+.. note::
+    See the documentation of Twig tags: http://twig.sensiolabs.org/doc/tags/index.html
+
+Advanced Haml syntax
+~~~~~~~~~~~~~~~~~~~~
+
+MtHaml support all of Haml's syntax, with one major difference: use Twig code instead of Ruby. See the reference: http://haml.info/docs/yardoc/file.REFERENCE.html#plain_text .
+
+