Cosmetic changes in docs

docs/development/contributing.rst

@@ -2,12 +2,12 @@ Contributing
 ==============================================
 
 I will be really pleased if you will provide patch to this Django app. Feel free
-in changing source code, but please keep `PEP8 <http://www.python.org/dev/peps/pep-0008/>`_
+to change whatever, but keep `PEP8 <http://www.python.org/dev/peps/pep-0008/>`_
 rules and `Zen <http://www.python.org/dev/peps/pep-0020/>`_.
 
 It is a good habit to cover your patches with :doc:`tests <testing>`.
 
-Our repository is placed on this URL:
+Repository is hosted on Github:
 https://github.com/yetty/django-embed-video
 
 

docs/development/testing.rst

@@ -33,8 +33,3 @@ Run tests with coverage:
   nosetests --with-coverage --cover-package=embed_video
 
 
-Testing HTTPS
--------------
-
-To test HTTPS on development server, `follow this instructions
-<http://www.ianlewis.org/en/testing-https-djangos-development-server>`_.

docs/development/todos.rst

@@ -1,8 +1,6 @@
 TODOs list
 ==============================================
 
-- provide AdminEmbedVideoMixin
-
 .. todolist::
 
 

docs/examples.rst

@@ -6,7 +6,7 @@ Template examples
 
 .. highlight:: html+django
 
-First you have to load the `embed_video_tags` template tags in your template:
+First you have to load the ``embed_video_tags`` template tags in your template:
 
 ::
 
@@ -36,13 +36,17 @@ Default sizes are ``tiny`` (420x315), ``small`` (480x360), ``medium`` (640x480),
     {% video my_video '800x600' %}
 
 
-.. note::
+.. tip::
 
   We recommend to use `sorl-thumbnail
   <http://sorl-thumbnail.readthedocs.org/en/latest/>`_ to `change
   <http://sorl-thumbnail.readthedocs.org/en/latest/examples.html#template-examples>`_
   thumbnail size.
 
+.. tip::
+
+  To speed up your pages, consider `template fragment caching
+  <https://docs.djangoproject.com/en/dev/topics/cache/#template-fragment-caching>`_.
 
 
 Model examples
@@ -50,7 +54,7 @@ Model examples
 
 .. highlight:: python
 
-Using the EmbedVideoField provides you validation of URLs.
+Using the ``EmbedVideoField`` provides you validation of URLs.
 
 ::
 
@@ -65,7 +69,7 @@ Using the EmbedVideoField provides you validation of URLs.
 Admin mixin examples
 ###############################################
 
-Use AdminVideoMixin in admin.py.
+Use ``AdminVideoMixin`` in ``admin.py``.
 
 ::
 

example_project/README.rst

@@ -1,5 +1,5 @@
-How to run it?
-**************
+Running example project
+***********************
 
 #. Install Django and PyYAML::
 
@@ -16,3 +16,10 @@ How to run it?
 
 #. Take a look at http://localhost:8000 . You can log in to administration with username ``admin``
    and password ``admin``.
+
+
+Testing HTTPS
+*************
+
+To test HTTPS on development server, `follow this instructions
+<http://www.ianlewis.org/en/testing-https-djangos-development-server>`_.