Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Various small improvements on the docs. #47

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Various small improvements on the docs. #47

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
958fcc0
internal link to autodoc'ed method jingo.helpers.f
magopian Nov 15, 2013
4ca271f
remove duplicated line in docs
magopian Nov 15, 2013
c5bc825
add project information and link to travis
magopian Nov 15, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,20 @@ Jingo

Jingo is an adapter for using Jinja2_ templates within Django.

.. image:: https://secure.travis-ci.org/jbalogh/jingo.png?branch=master
:alt: Build Status
:target: https://secure.travis-ci.org/jbalogh/jingo

:Author: Jeff Balogh and contributors_
:Licence: BSD
:Compatibility: Python 2.6, 2.7 and 3.3, Django 1.4, 1.5 and 1.6
:Requirements: jinja2
:Project URL: https://github.com/jbalogh/jingo/
:Documentation: http://jingo.readthedocs.org/en/latest/

.. _contributors: https://github.com/jbalogh/jingo/contributors


.. note:: Coffin or Jingo?

Jingo differs from Coffin_ in two major ways:
Expand Down
19 changes: 14 additions & 5 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,19 @@ Jingo

Jingo is an adapter for using Jinja2_ templates within Django.

.. image:: https://secure.travis-ci.org/jbalogh/jingo.png?branch=master
:alt: Build Status
:target: https://secure.travis-ci.org/jbalogh/jingo

* Author: Jeff Balogh and contributors_
* Licence: BSD
* Compatibility: Python 2.6, 2.7 and 3.3, Django 1.4, 1.5 and 1.6
* Requirements: jinja2
* Project URL: https://github.com/jbalogh/jingo/
* Documentation: http://jingo.readthedocs.org/en/latest/

.. _contributors: https://github.com/jbalogh/jingo/contributors

.. note:: Coffin or Jingo?

Jingo differs from Coffin_ in two major ways:
Expand Down Expand Up @@ -149,8 +162,7 @@ Since we all love L10n, let's see what it looks like in Jinja templates::
<h2>{{ _('Reviews for {0}')|f(addon.name) }}</h2>

The simple way is to use the familiar underscore and string within a ``{{ }}``
moustache block. ``f`` is an interpolation filter documented below. Sphinx
could create a link if I knew how to do that.
moustache block. :meth:`f` is an interpolation filter documented above.

The other method uses Jinja's ``trans`` tag::

Expand All @@ -165,9 +177,6 @@ directly. Both methods are useful, pick the one that makes you happy.
Forms
-----

Django marks its form HTML "safe" according to its own rules, which Jinja2 does
not recognize.

.. automodule:: jingo.monkey


Expand Down