Added documentation about overwriting theme

Signed-off-by: Carlos Oliveira <carlospecter@gmail.com>

Added documentation about overwriting theme
Signed-off-by: Carlos Oliveira <carlospecter@gmail.com>
Carlos Coêlho
1 parent 7311c66e
Showing 1 changed file with 12 additions and 5 deletions Show diff stats
docs/source/user.rst
@@ -90,19 +90,26 @@ Extra Template Folders
  
 .. attribute:: COLAB_TEMPLATES
  
-   :default: None
-
-   Colab's extra template folders. Use it to add plugins template files.
+   :default: () (Empty tuple)
  
+   Colab's extra template folders. Use it to add plugins template files, and
+   remember to use the app hierarchy, e.g if your app name is example, then
+   you should put your templates inside ``COLAB_TEMPLATES/example``.
+   You can also use it to overwrite the default templates, e.g. if you want
+   to overwrite the default footer, you simply need to add a file named
+   ``footer.html`` to the folder where ``COLAB_TEMPLATES`` points to.
  
 Extra Static Folders
 ++++++++++++++++++++
  
 .. attribute:: COLAB_STATIC
  
-   :default: None
+   :default: [] (Empty list)
+
+   Colab's extra static folders. Use it to add plugins static files. It's used
+   the same way COLAB_TEMPLATES is. Use it to overwrite or add your own static
+   files, such as CSS/JS files and/or images.
  
-   Colab's extra static folders. Use it to add plugins static files.
  
 Settings
 --------
...	...	@@ -90,19 +90,26 @@ Extra Template Folders
90	90
91	91	.. attribute:: COLAB_TEMPLATES
92	92
93		- :default: None
94		-
95		- Colab's extra template folders. Use it to add plugins template files.
	93	+ :default: () (Empty tuple)
96	94
	95	+ Colab's extra template folders. Use it to add plugins template files, and
	96	+ remember to use the app hierarchy, e.g if your app name is example, then
	97	+ you should put your templates inside ``COLAB_TEMPLATES/example``.
	98	+ You can also use it to overwrite the default templates, e.g. if you want
	99	+ to overwrite the default footer, you simply need to add a file named
	100	+ ``footer.html`` to the folder where ``COLAB_TEMPLATES`` points to.
97	101
98	102	Extra Static Folders
99	103	++++++++++++++++++++
100	104
101	105	.. attribute:: COLAB_STATIC
102	106
103		- :default: None
	107	+ :default: [] (Empty list)
	108	+
	109	+ Colab's extra static folders. Use it to add plugins static files. It's used
	110	+ the same way COLAB_TEMPLATES is. Use it to overwrite or add your own static
	111	+ files, such as CSS/JS files and/or images.
104	112
105		- Colab's extra static folders. Use it to add plugins static files.
106	113
107	114	Settings
108	115	--------
...	...