Update documentation

mbourqui · Jan 27, 2019 · fad7f46 · fad7f46
1 parent ea05c8f
commit fad7f46
Show file tree

Hide file tree

Showing 3 changed files with 55 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,4 +13,5 @@ Icons for Django
    demo
    api
    templatetags
+   renderers
    settings
diff --git a/docs/renderers.rst b/docs/renderers.rst
@@ -0,0 +1,33 @@
+=========================
+Renderers
+=========================
+
+
+Bootstrap3
+~~~~
+
+.. autofunction:: django_icons.renderers.Bootstrap3Renderer.Bootstrap3Renderer
+
+
+Font Awesome 4
+~~~~
+
+.. autofunction:: django_icons.renderers.fontawesome.FontAwesomeRenderer
+
+
+Material
+~~~~
+
+.. autofunction:: django_icons.renderers.material.MaterialRenderer
+
+
+Icons 8
+~~~~
+
+.. autofunction:: django_icons.renderers.image.Icons8PngCdnRenderer
+
+
+Local files
+~~~~
+
+.. autofunction:: django_icons.renderers.image.ImageRenderer
diff --git a/docs/templatetags.rst b/docs/templatetags.rst
@@ -15,3 +15,24 @@ icon
 ~~~~
 
 .. autofunction:: django_icons.templatetags.icons.icon
+
+
+Renderers
+=========
+
+Some renderers support additional parameters.
+
+
+ImageRenderer & Icons8PngCdnRenderer
+------------------------------------
+
+To get a variant representation of an icon (assuming that variant exists), you can specify:
+
+size : int
+    The size for this icon, if different from the default value. When using the ImageRenderer, the icon file name must contain that value.
+
+color : str
+    The color for this icon, if different from the default value. When using the ImageRenderer, the icon file name must contain that value.
+
+format : str
+    The format (file extension) for this icon, if different from the default value. When using the ImageRenderer, the icon file name must have that extension.