Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
D
django-pipeline
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
OpenEdx
django-pipeline
Commits
4565e235
Commit
4565e235
authored
May 11, 2012
by
Alexis Svinartchouk
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
fixed some typos in the docs
parent
358a2dae
Show whitespace changes
Inline
Side-by-side
Showing
7 changed files
with
25 additions
and
25 deletions
+25
-25
docs/compilers.rst
+7
-7
docs/compressors.rst
+8
-8
docs/configuration.rst
+6
-6
docs/installation.rst
+1
-1
docs/signals.rst
+1
-1
docs/storages.rst
+1
-1
docs/templates.rst
+1
-1
No files found.
docs/compilers.rst
View file @
4565e235
...
@@ -8,7 +8,7 @@ Compilers
...
@@ -8,7 +8,7 @@ Compilers
Coffee Script compiler
Coffee Script compiler
======================
======================
The Coffee Script compiler use `Coffee Script <http://jashkenas.github.com/coffee-script/>`_
The Coffee Script compiler use
s
`Coffee Script <http://jashkenas.github.com/coffee-script/>`_
to compile your javascripts.
to compile your javascripts.
To use it add this to your ``PIPELINE_COMPILERS`` ::
To use it add this to your ``PIPELINE_COMPILERS`` ::
...
@@ -35,7 +35,7 @@ To use it add this to your ``PIPELINE_COMPILERS`` ::
...
@@ -35,7 +35,7 @@ To use it add this to your ``PIPELINE_COMPILERS`` ::
LESS compiler
LESS compiler
=============
=============
The LESS compiler use `LESS <http://lesscss.org/>`_
The LESS compiler use
s
`LESS <http://lesscss.org/>`_
to compile your stylesheets.
to compile your stylesheets.
To use it add this to your ``PIPELINE_COMPILERS`` ::
To use it add this to your ``PIPELINE_COMPILERS`` ::
...
@@ -62,7 +62,7 @@ To use it add this to your ``PIPELINE_COMPILERS`` ::
...
@@ -62,7 +62,7 @@ To use it add this to your ``PIPELINE_COMPILERS`` ::
SASS compiler
SASS compiler
=============
=============
The SASS compiler use `SASS <http://sass-lang.com/>`_
The SASS compiler use
s
`SASS <http://sass-lang.com/>`_
to compile your stylesheets.
to compile your stylesheets.
To use it add this to your ``PIPELINE_COMPILERS`` ::
To use it add this to your ``PIPELINE_COMPILERS`` ::
...
@@ -91,7 +91,7 @@ To use it add this to your ``PIPELINE_COMPILERS`` ::
...
@@ -91,7 +91,7 @@ To use it add this to your ``PIPELINE_COMPILERS`` ::
Stylus compiler
Stylus compiler
===============
===============
The Stylus compiler use `Stylus <http://learnboost.github.com/stylus/>`
The Stylus compiler use
s
`Stylus <http://learnboost.github.com/stylus/>`
to compile your stylesheets.
to compile your stylesheets.
To use it add this to your ``PIPELINE_COMPILERS`` ::
To use it add this to your ``PIPELINE_COMPILERS`` ::
...
@@ -121,10 +121,10 @@ To use it add this to your ``PIPELINE_COMPILERS`` ::
...
@@ -121,10 +121,10 @@ To use it add this to your ``PIPELINE_COMPILERS`` ::
Write your own compiler class
Write your own compiler class
=============================
=============================
To write your own compiler class, for example
want to implement other types
You can write your own compiler class, for example if you
want to implement other types
of compilers.
of compilers.
All you need to do is
to create a class that inherits from ``pipeline.compilers.CompilerBase``
To do so, you just have
to create a class that inherits from ``pipeline.compilers.CompilerBase``
and implements ``match_file`` and ``compile_file`` when needed.
and implements ``match_file`` and ``compile_file`` when needed.
Finally, specify it in the tuple of compilers ``PIPELINE_COMPILERS`` in the settings.
Finally, specify it in the tuple of compilers ``PIPELINE_COMPILERS`` in the settings.
...
@@ -132,7 +132,7 @@ Finally, specify it in the tuple of compilers ``PIPELINE_COMPILERS`` in the sett
...
@@ -132,7 +132,7 @@ Finally, specify it in the tuple of compilers ``PIPELINE_COMPILERS`` in the sett
Example
Example
-------
-------
A custom compiler for a imaginary compiler called jam ::
A custom compiler for a
n
imaginary compiler called jam ::
from pipeline.compilers import CompilerBase
from pipeline.compilers import CompilerBase
...
...
docs/compressors.rst
View file @
4565e235
...
@@ -8,7 +8,7 @@ Compressors
...
@@ -8,7 +8,7 @@ Compressors
YUI Compressor compressor
YUI Compressor compressor
=========================
=========================
The YUI compressor use `yui-compressor <http://developer.yahoo.com/yui/compressor/>`_
The YUI compressor use
s
`yui-compressor <http://developer.yahoo.com/yui/compressor/>`_
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`` ::
...
@@ -50,7 +50,7 @@ To use it for your javascripts add this to your ``PIPELINE_JS_COMPRESSOR`` ::
...
@@ -50,7 +50,7 @@ To use it for your javascripts add this to your ``PIPELINE_JS_COMPRESSOR`` ::
Closure Compiler compressor
Closure Compiler compressor
===========================
===========================
The Closure compressor use `Google Closure Compiler <http://code.google.com/closure/compiler/>`_
The Closure compressor use
s
`Google Closure Compiler <http://code.google.com/closure/compiler/>`_
to compress javascripts.
to compress javascripts.
To use it add this to your ``PIPELINE_JS_COMPRESSOR`` ::
To use it add this to your ``PIPELINE_JS_COMPRESSOR`` ::
...
@@ -83,7 +83,7 @@ To use it add this to your ``PIPELINE_JS_COMPRESSOR`` ::
...
@@ -83,7 +83,7 @@ To use it add this to your ``PIPELINE_JS_COMPRESSOR`` ::
UglifyJS compressor
UglifyJS compressor
===================
===================
The UglifyJS compressor use `UglifyJS <https://github.com/mishoo/UglifyJS/>`_ to
The UglifyJS compressor use
s
`UglifyJS <https://github.com/mishoo/UglifyJS/>`_ to
compress javascripts.
compress javascripts.
To use it add this to your ``PIPELINE_JS_COMPRESSOR`` ::
To use it add this to your ``PIPELINE_JS_COMPRESSOR`` ::
...
@@ -110,7 +110,7 @@ To use it add this to your ``PIPELINE_JS_COMPRESSOR`` ::
...
@@ -110,7 +110,7 @@ To use it add this to your ``PIPELINE_JS_COMPRESSOR`` ::
JSMin compressor
JSMin compressor
================
================
The jsmin compressor use Douglas Crockford jsmin tool to
The jsmin compressor use
s
Douglas Crockford jsmin tool to
compress javascripts.
compress javascripts.
To use it add this to your ``PIPELINE_JS_COMPRESSOR`` ::
To use it add this to your ``PIPELINE_JS_COMPRESSOR`` ::
...
@@ -125,7 +125,7 @@ Install the jsmin library with your favorite Python package manager ::
...
@@ -125,7 +125,7 @@ Install the jsmin library with your favorite Python package manager ::
CSSTidy compressor
CSSTidy compressor
==================
==================
The CSStidy compressor use `CSStidy <http://csstidy.sourceforge.net/>`_ to compress
The CSStidy compressor use
s
`CSStidy <http://csstidy.sourceforge.net/>`_ to compress
stylesheets.
stylesheets.
To us it for your stylesheets add this to your ``PIPELINE_CSS_COMPRESSOR`` ::
To us it for your stylesheets add this to your ``PIPELINE_CSS_COMPRESSOR`` ::
...
@@ -163,10 +163,10 @@ Install the cssmin library with your favorite Python package manager. E.g. ::
...
@@ -163,10 +163,10 @@ Install the cssmin library with your favorite Python package manager. E.g. ::
Write your own compressor class
Write your own compressor class
===============================
===============================
To write your own compressor class, for example
want to implement other types
You can write your own compressor class, for example if you
want to implement other types
of compressors.
of compressors.
All you need to do is
to create a class that inherits from ``pipeline.compressors.CompressorBase``
To do so, you just have
to create a class that inherits from ``pipeline.compressors.CompressorBase``
and implements ``compress_css`` and/or a ``compress_js`` when needed.
and implements ``compress_css`` and/or a ``compress_js`` when needed.
Finally, add it to ``PIPELINE_CSS_COMPRESSOR`` or
Finally, add it to ``PIPELINE_CSS_COMPRESSOR`` or
...
@@ -175,7 +175,7 @@ Finally, add it to ``PIPELINE_CSS_COMPRESSOR`` or
...
@@ -175,7 +175,7 @@ Finally, add it to ``PIPELINE_CSS_COMPRESSOR`` or
Example
Example
-------
-------
A custom compressor for a imaginary compressor called jam ::
A custom compressor for a
n
imaginary compressor called jam ::
from pipeline.compressors import CompressorBase
from pipeline.compressors import CompressorBase
...
...
docs/configuration.rst
View file @
4565e235
...
@@ -51,7 +51,7 @@ Group options
...
@@ -51,7 +51,7 @@ Group options
**Required**
**Required**
Is a tuple with the source files to be compressed.
Is a tuple with the source files to be compressed.
The files are concatenated in the order
it is
specified in the tuple.
The files are concatenated in the order specified in the tuple.
``output_filename``
``output_filename``
...
@@ -147,7 +147,7 @@ Other settings
...
@@ -147,7 +147,7 @@ Other settings
``PIPELINE_TEMPLATE_EXT``
``PIPELINE_TEMPLATE_EXT``
.........................
.........................
The extension for which Pipeline will consider the file as a Javascript template
s
.
The extension for which Pipeline will consider the file as a Javascript template.
To use a different extension, like ``.mustache``, set this settings to ``.mustache``.
To use a different extension, like ``.mustache``, set this settings to ``.mustache``.
Defaults to ``".jst"``
Defaults to ``".jst"``
...
@@ -157,7 +157,7 @@ Other settings
...
@@ -157,7 +157,7 @@ Other settings
JavaScript function that compiles your JavaScript templates.
JavaScript function that compiles your JavaScript templates.
Pipeline doesn't bundle a javascript template library, but the default
Pipeline doesn't bundle a javascript template library, but the default
setting
s
is to use the
setting is to use the
`underscore <http://documentcloud.github.com/underscore/>`_ template function.
`underscore <http://documentcloud.github.com/underscore/>`_ template function.
Defaults to ``"_.template"``
Defaults to ``"_.template"``
...
@@ -167,7 +167,7 @@ Embedding fonts and images
...
@@ -167,7 +167,7 @@ Embedding fonts and images
==========================
==========================
You can embed fonts and images directly in your compiled css, using Data-URI in
You can embed fonts and images directly in your compiled css, using Data-URI in
modern browser.
modern browser
s
.
To do so, setup variant group options to the method you wish to use : ::
To do so, setup variant group options to the method you wish to use : ::
...
@@ -192,8 +192,8 @@ Images and fonts are embedded following these rules :
...
@@ -192,8 +192,8 @@ Images and fonts are embedded following these rules :
Rewriting CSS urls
Rewriting CSS urls
==================
==================
If
source CSS contain a relative URL
(i.e. relative to current file),
If
the source CSS contains relative URLs
(i.e. relative to current file),
those URL will be converted to full relative path.
those URL
s
will be converted to full relative path.
Wrapped javascript output
Wrapped javascript output
...
...
docs/installation.rst
View file @
4565e235
...
@@ -9,7 +9,7 @@ Installation
...
@@ -9,7 +9,7 @@ Installation
pip install django-pipeline
pip install django-pipeline
2. Add '
compress
' to your ``INSTALLED_APPS`` ::
2. Add '
pipeline
' to your ``INSTALLED_APPS`` ::
INSTALLED_APPS = (
INSTALLED_APPS = (
'pipeline',
'pipeline',
...
...
docs/signals.rst
View file @
4565e235
...
@@ -4,7 +4,7 @@
...
@@ -4,7 +4,7 @@
Signals
Signals
=======
=======
A list of all signals send
by pipeline.
List of all signals sent
by pipeline.
css_compressed
css_compressed
--------------
--------------
...
...
docs/storages.rst
View file @
4565e235
...
@@ -7,7 +7,7 @@ Storages
...
@@ -7,7 +7,7 @@ Storages
Using with a custom storage
Using with a custom storage
===========================
===========================
Pipeline use `Django Storage <https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/#storages>`_
Pipeline use
s
`Django Storage <https://docs.djangoproject.com/en/dev/ref/contrib/staticfiles/#storages>`_
to read, save and delete files, by default it use an improved ``StaticFilesStorage``.
to read, save and delete files, by default it use an improved ``StaticFilesStorage``.
You can provide your own via ``PIPELINE_STORAGE`` : ::
You can provide your own via ``PIPELINE_STORAGE`` : ::
...
...
docs/templates.rst
View file @
4565e235
...
@@ -26,7 +26,7 @@ For example, if you have the following template ``js/templates/photo/detail.jst`
...
@@ -26,7 +26,7 @@ For example, if you have the following template ``js/templates/photo/detail.jst`
</div>
</div>
</div>
</div>
They
will be available from your javascript code via window.JST ::
It
will be available from your javascript code via window.JST ::
JST.photo_detail({ src:"images/baby-panda.jpg", caption:"A baby panda is born" });
JST.photo_detail({ src:"images/baby-panda.jpg", caption:"A baby panda is born" });
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment