diff options
author | Carl A Dunham <cdunham@gmail.com> | 2014-01-18 15:26:10 -0600 |
---|---|---|
committer | Carl A Dunham <cdunham@gmail.com> | 2014-01-18 15:26:10 -0600 |
commit | d546358cf53e97e0f902aac62af64375b415fd1f (patch) | |
tree | 526919ca839c5f917d3a2f0b7574cccf5786641c /docs | |
parent | 27ffd01f95cad7740497a32b22e4ef9d29762162 (diff) | |
download | jinja2-d546358cf53e97e0f902aac62af64375b415fd1f.tar.gz |
fixed some typos and clarifying
Diffstat (limited to 'docs')
-rw-r--r-- | docs/api.rst | 2 | ||||
-rw-r--r-- | docs/index.rst | 4 | ||||
-rw-r--r-- | docs/intro.rst | 15 |
3 files changed, 10 insertions, 11 deletions
diff --git a/docs/api.rst b/docs/api.rst index ae2295f..a1e538f 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -12,7 +12,7 @@ Basics ------ Jinja2 uses a central object called the template :class:`Environment`. -Instances of this class are used to store the configuration, global objects +Instances of this class are used to store the configuration and global objects, and are used to load templates from the file system or other locations. Even if you are creating templates from strings by using the constructor of :class:`Template` class, an environment is created automatically for you, diff --git a/docs/index.rst b/docs/index.rst index c8964f6..a08d628 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ Welcome to Jinja2 ================= -Jinja2 is a modern and designer friendly templating language for Python, +Jinja2 is a modern and designer-friendly templating language for Python, modelled after Django's templates. It is fast, widely used and secure with the optional sandboxed template execution environment: @@ -20,7 +20,7 @@ with the optional sandboxed template execution environment: - powerful automatic HTML escaping system for XSS prevention - template inheritance - compiles down to the optimal python code just in time -- optional ahead of time template compilation +- optional ahead-of-time template compilation - easy to debug. Line numbers of exceptions directly point to the correct line in the template. - configurable syntax diff --git a/docs/intro.rst b/docs/intro.rst index eac97ac..99c3582 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -17,7 +17,7 @@ Jinja2 works with Python 2.6.x, 2.7.x and >= 3.3. If you are using Python was dropped in Jinja2 version 2.7. If you wish to use the :class:`~jinja2.PackageLoader` class, you will also -need setuptools or distribute installed at runtime. +need `setuptools`_ or `distribute`_ installed at runtime. Installation ------------ @@ -25,8 +25,8 @@ Installation You have multiple ways to install Jinja2. If you are unsure what to do, go with the Python egg or tarball. -As a Python egg (via easy_install) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +As a Python egg (via `easy_install`) +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can install the most recent Jinja2 version using `easy_install`_ or `pip`_:: @@ -46,13 +46,11 @@ From the tarball release 2. Unpack the tarball 3. ``sudo python setup.py install`` -Note that you either have to have setuptools or `distribute`_ installed; +Note that you either have to have `setuptools` or `distribute` installed; the latter is preferred. This will install Jinja2 into your Python installation's site-packages directory. -.. _distribute: http://pypi.python.org/pypi/distribute - Installing the development version ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -62,10 +60,11 @@ Installing the development version 4. ``ln -s jinja2 /usr/lib/python2.X/site-packages`` As an alternative to steps 4 you can also do ``python setup.py develop`` -which will install the package via distribute in development mode. This also +which will install the package via `distribute` in development mode. This also has the advantage that the C extensions are compiled. .. _download page: http://pypi.python.org/pypi/Jinja2 +.. _distribute: http://pypi.python.org/pypi/distribute .. _setuptools: http://peak.telecommunity.com/DevCenter/setuptools .. _easy_install: http://peak.telecommunity.com/DevCenter/EasyInstall .. _pip: http://pypi.python.org/pypi/pip @@ -117,7 +116,7 @@ there and behavior might be inconsistent. If you notice any bugs, please provide feedback in the `Jinja bug tracker`_. Also please keep in mind that the documentation is written with Python 2 -in mind, you will have to adapt the shown code examples to Python 3 syntax +in mind, so you will have to adapt the shown code examples to Python 3 syntax for yourself. |