Doc for scss

README.md

@@ -35,9 +35,11 @@ The development is done with sqlite, but it is advised to set a more robust DBMS
 
 ### Collecting statics for production:
 
+We use scss in the project. In development environment (DEBUG=True), scss is compiled every time the file is needed. For production, it assumes you have already compiled every files and to do so, you need to use the following commands : 
+
 ```
-./manage.py collectstatic
-./manage.py compilestatic
+./manage.py collectstatic # To collect statics
+./manage.py compilestatic # To compile scss in those statics
 ```
 
 ### Misc about development

core/management/commands/compilestatic.py

@@ -30,6 +30,9 @@ from django.conf import settings
 
 
 class Command(BaseCommand):
+    """
+        Compiles scss in static folder for production
+    """
     help = "Compile scss files from static folder"
 
     def compile(self, filename):

core/scss/processor.py

@@ -34,6 +34,11 @@ from core.scss.storage import ScssFileStorage, find_file
 
 
 class ScssProcessor(object):
+    """
+        If DEBUG mode enabled : compile the scss file
+        Else : give the path of the corresponding css supposed to already be compiled
+        Don't forget to use compilestatics to compile scss for production
+    """
     prefix = iri_to_uri(getattr(settings, 'STATIC_URL', '/static/'))
     storage = ScssFileStorage()
     scss_extensions = [".scss"]

core/templatetags/renderer.py

@@ -53,5 +53,8 @@ def datetime_format_python_to_PHP(python_format_string):
 
 @register.simple_tag()
 def scss(path):
+    """
+        Return path of the corresponding css file after compilation
+    """
     processor = ScssProcessor(path)
     return processor.get_converted_scss()