Merge pull request #1495 from Flimm/document_validate_templates

Improve documentation of validate_templates

docs/command_extensions.rst

@@ -121,7 +121,7 @@ Current Command Extensions
 
 * *update_permissions* - Reloads permissions for specified apps, or all apps if no args are specified.
 
-* *validate_templates* - Validate templates on syntax and compile errors.
+* :doc:`validate_templates` - Validate templates on syntax and compile errors.
 
 * *set_default_site* - Set parameters of the default `django.contrib.sites` Site using `name` and `domain` or `system-fqdn`.
 

docs/validate_templates.rst

@@ -3,6 +3,18 @@ validate_templates
 
 :synopsis: Checks templates on syntax or compile errors.
 
+This will catch any invalid Django template syntax, for example::
+
+    {% foobar %}
+
+    {% comment %}
+    This throws this error:
+    TemplateSyntaxError Invalid block tag on line 1: 'foobar'. Did you forget to register or load this tag?
+    {% endcomment %}
+
+Note that this will not catch invalid HTML, only errors in the Django template
+syntax used.
+
 Options
 -------
 
@@ -56,4 +68,17 @@ check those as well.
 Usage Example
 -------------
 
- ./manage.py validate_templates
+::
+
+    ./manage.py validate_templates
+
+
+You can also integrate it with your tests, like this::
+
+    import unittest
+    from django.core.management import call_command
+
+    class MyTests(unittest.TestCase):
+        def test_validate_templates(self):
+            call_command("validate_templates")
+            # This throws an error if it fails to validate