Commit d5575271 by Timothée Peignier

update compressor and compiler docs

parent 55a3ae67
...@@ -23,13 +23,13 @@ To use it add this to your ``PIPELINE_COMPILERS`` :: ...@@ -23,13 +23,13 @@ To use it add this to your ``PIPELINE_COMPILERS`` ::
Command line to execute for coffee program. Command line to execute for coffee program.
You will most likely change this to the location of coffee on your system. You will most likely change this to the location of coffee on your system.
Defaults to ``'/usr/local/bin/coffee'``. Defaults to ``'/usr/bin/env coffee'``.
``PIPELINE_COFFEE_SCRIPT_ARGUMENTS`` ``PIPELINE_COFFEE_SCRIPT_ARGUMENTS``
------------------------------------ ------------------------------------
Additional arguments to use when coffee is called. Additional arguments to use when coffee is called.
Defaults to ``''``. Defaults to ``''``.
LESS compiler LESS compiler
...@@ -50,7 +50,7 @@ To use it add this to your ``PIPELINE_COMPILERS`` :: ...@@ -50,7 +50,7 @@ To use it add this to your ``PIPELINE_COMPILERS`` ::
Command line to execute for lessc program. Command line to execute for lessc program.
You will most likely change this to the location of lessc on your system. You will most likely change this to the location of lessc on your system.
Defaults to ``'/usr/local/bin/lessc'``. Defaults to ``'/usr/bin/env lessc'``.
``PIPELINE_LESS_ARGUMENTS`` ``PIPELINE_LESS_ARGUMENTS``
--------------------------- ---------------------------
...@@ -74,15 +74,15 @@ To use it add this to your ``PIPELINE_COMPILERS`` :: ...@@ -74,15 +74,15 @@ To use it add this to your ``PIPELINE_COMPILERS`` ::
``PIPELINE_SASS_BINARY`` ``PIPELINE_SASS_BINARY``
------------------------ ------------------------
Command line to execute for sass program. Command line to execute for sass program.
You will most likely change this to the location of sass on your system. You will most likely change this to the location of sass on your system.
Defaults to ``'/usr/local/bin/sass'``. Defaults to ``'/usr/bin/env sass'``.
``PIPELINE_SASS_ARGUMENTS`` ``PIPELINE_SASS_ARGUMENTS``
--------------------------- ---------------------------
Additional arguments to use when sass is called. Additional arguments to use when sass is called.
Defaults to ``''``. Defaults to ``''``.
...@@ -106,14 +106,14 @@ To use it add this to your ``PIPELINE_COMPILERS`` :: ...@@ -106,14 +106,14 @@ To use it add this to your ``PIPELINE_COMPILERS`` ::
Command line to execute for stylus program. Command line to execute for stylus program.
You will most likely change this to the location of stylus on your system. You will most likely change this to the location of stylus on your system.
Defaults to ``'/usr/local/bin/stylus'``. Defaults to ``'/usr/bin/env stylus'``.
``PIPELINE_STYLUS_ARGUMENTS`` ``PIPELINE_STYLUS_ARGUMENTS``
----------------------------- -----------------------------
Additional arguments to use when stylus is called. Additional arguments to use when stylus is called.
Defaults to ``''``. Defaults to ``''``.
...@@ -135,13 +135,13 @@ Example ...@@ -135,13 +135,13 @@ Example
A custom compiler for an imaginary compiler called jam :: A custom compiler for an imaginary compiler called jam ::
from pipeline.compilers import CompilerBase from pipeline.compilers import CompilerBase
class JamCompiler(CompilerBase): class JamCompiler(CompilerBase):
output_extension = 'js' output_extension = 'js'
def match_file(self, filename): def match_file(self, filename):
return filename.endswith('.jam') return filename.endswith('.jam')
def compile_file(self, infile, outfile, outdated=False, force=False): def compile_file(self, infile, outfile, outdated=False, force=False):
if not outdated and not force: if not outdated and not force:
return # No need to recompiled file return # No need to recompiled file
......
...@@ -5,10 +5,10 @@ Compressors ...@@ -5,10 +5,10 @@ Compressors
=========== ===========
YUI Compressor compressor YUI compressor
========================= =========================
The YUI compressor uses `yui-compressor <http://developer.yahoo.com/yui/compressor/>`_ The YUI compressor uses `yuglify <http://github.com/yui/yuglify>`_
for compressing javascript and stylesheets. for compressing javascript and stylesheets.
To use it for your stylesheets add this to your ``PIPELINE_CSS_COMPRESSOR`` :: To use it for your stylesheets add this to your ``PIPELINE_CSS_COMPRESSOR`` ::
...@@ -26,11 +26,7 @@ To use it for your javascripts add this to your ``PIPELINE_JS_COMPRESSOR`` :: ...@@ -26,11 +26,7 @@ To use it for your javascripts add this to your ``PIPELINE_JS_COMPRESSOR`` ::
Command line to execute for the YUI program. Command line to execute for the YUI program.
You will most likely change this to the location of yui-compressor on your system. You will most likely change this to the location of yui-compressor on your system.
Defaults to ``'/usr/local/bin/yuicompressor'``. Defaults to ``'/usr/bin/env yuglify'``.
.. warning::
Don't point to ``yuicompressor.jar`` directly, we expect to find a executable script.
``PIPELINE_YUI_CSS_ARGUMENTS`` ``PIPELINE_YUI_CSS_ARGUMENTS``
------------------------------ ------------------------------
...@@ -66,7 +62,7 @@ To use it add this to your ``PIPELINE_JS_COMPRESSOR`` :: ...@@ -66,7 +62,7 @@ To use it add this to your ``PIPELINE_JS_COMPRESSOR`` ::
Command line to execute for the Closure Compiler program. Command line to execute for the Closure Compiler program.
You will most likely change this to the location of closure on your system. You will most likely change this to the location of closure on your system.
Default to ``'/usr/local/bin/closure'`` Default to ``'/usr/bin/env closure'``
.. warning:: .. warning::
Don't point to ``compiler.jar`` directly, we expect to find a executable script. Don't point to ``compiler.jar`` directly, we expect to find a executable script.
...@@ -97,7 +93,7 @@ To use it add this to your ``PIPELINE_JS_COMPRESSOR`` :: ...@@ -97,7 +93,7 @@ To use it add this to your ``PIPELINE_JS_COMPRESSOR`` ::
Command line to execute for the Closure Compiler program. Command line to execute for the Closure Compiler program.
You will most likely change this to the location of closure on your system. You will most likely change this to the location of closure on your system.
Defaults to ``'/usr/local/bin/uglifyjs'``. Defaults to ``'/usr/bin/env uglifyjs'``.
``PIPELINE_UGLIFYJS_ARGUMENTS`` ``PIPELINE_UGLIFYJS_ARGUMENTS``
------------------------------- -------------------------------
...@@ -153,7 +149,7 @@ To us it for your stylesheets add this to your ``PIPELINE_CSS_COMPRESSOR`` :: ...@@ -153,7 +149,7 @@ To us it for your stylesheets add this to your ``PIPELINE_CSS_COMPRESSOR`` ::
Command line to execute for csstidy program. Command line to execute for csstidy program.
You will most likely change this to the location of csstidy on your system. You will most likely change this to the location of csstidy on your system.
Defaults to ``'/usr/local/bin/csstidy'`` Defaults to ``'/usr/bin/env csstidy'``
``PIPELINE_CSSTIDY_ARGUMENTS`` ``PIPELINE_CSSTIDY_ARGUMENTS``
------------------------------ ------------------------------
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment