feat: implicitly include static files in the template

include_static templatetag is now deprecated.

README.rst

@@ -212,8 +212,6 @@ Usage
 1. Basics usage:
 ----------------
 
-``include_static`` this tag will include CSS and javascript files,
-
 ``include_bootstrap`` tag is for bootstrap-4.1.1, if it’s already used in the project, get rid of this tag.
 
 In the template (e.g. post_detail.) add the following template tags where ``obj`` is the instance of post model.
@@ -222,6 +220,7 @@ In the template (e.g. post_detail.) add the following template tags where ``obj`
 
     {% load comment_tags %}  {# Loading the template tag #}
     {% render_comments obj request %}  {# Render all the comments belong to the passed object "obj" #}
+    {% include_bootstrap %} {# Include bootstrap 4.1.1 - remove this line if BS is already used in your project #}
 
 
 2. Advanced usage:

comment/templates/comment/base.html

@@ -0,0 +1,2 @@
+{% include 'comment/static.html' %}
+{% include 'comment/comments/base.html' %}

comment/templatetags/comment_tags.py

@@ -82,7 +82,7 @@ def render_comments(obj, request, oauth=False):
     return context
 
 
-register.inclusion_tag('comment/comments/base.html')(render_comments)
+register.inclusion_tag('comment/base.html')(render_comments)
 
 
 def render_content(comment, number):
@@ -111,12 +111,10 @@ def can_delete_comment(comment, user):
 register.inclusion_tag('comment/comments/content.html')(render_content)
 
 
+@register.simple_tag(name='include_static')
 def include_static():
-    """ include static files """
-    return None
-
-
-register.inclusion_tag('comment/static.html')(include_static)
+    """ This function shall be deprecated """
+    return ''
 
 
 def include_bootstrap():

comment/tests/test_template_tags.py

@@ -108,7 +108,7 @@ def test_render_comments(self):
         self.assertTrue(data['comments'].has_previous())
 
     def test_static_functions(self):
-        self.assertIsNone(include_static())
+        self.assertEqual(include_static(), '')
         self.assertIsNone(include_bootstrap())
 
     def test_render_field(self):

docs/source/usage.rst

@@ -4,8 +4,6 @@ Usage
 1. Basics usage:
 ----------------
 
-``include_static`` this tag will include CSS and javascript files,
-
 ``include_bootstrap`` tag is for bootstrap-4.1.1, if it’s already used in the project, get rid of this tag.
 
 In the template (e.g. post_detail.) add the following template tags where ``obj`` is the instance of post model.
@@ -14,6 +12,7 @@ In the template (e.g. post_detail.) add the following template tags where ``obj`
 
     {% load comment_tags %}  {# Loading the template tag #}
     {% render_comments obj request %}  {# Render all the comments belong to the passed object "obj" #}
+    {% include_bootstrap %} {# Include bootstrap 4.1.1 - remove this line if BS is already used in your project #}
 
 
 2. Advanced usage:
@@ -32,7 +31,6 @@ To change the default number, set ``COMMENT_PER_PAGE=number``.
 
     {% render_comments obj request %}  {# Include comments belonging to a certain object #}
     {% include_bootstrap %} {# Include bootstrap 4.1.1 - remove this line if BS 4.1.1 is already used in your project #}
-    {% include_static %} {# Include comment CSS and JS files #}