updated pydoc documentation

1 files changed, 40 insertions, 5 deletions

diff --git a/doc/pydoc/ranger.gui.colorscheme.html b/doc/pydoc/ranger.gui.colorscheme.html
index 5bc0e2df..d7b07f59 100644
--- a/doc/pydoc/ranger.gui.colorscheme.html
+++ b/doc/pydoc/ranger.gui.colorscheme.html
@@ -9,7 +9,31 @@
 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="ranger.html"><font color="#ffffff">ranger</font></a>.<a href="ranger.gui.html"><font color="#ffffff">gui</font></a>.colorscheme</strong></big></big></font></td
 ><td align=right valign=bottom
 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/hut/work/ranger/ranger/gui/colorscheme.py">/home/hut/work/ranger/ranger/gui/colorscheme.py</a></font></td></tr></table>
-    <p></p>
+    <p><tt>Colorschemes&nbsp;define&nbsp;colors&nbsp;for&nbsp;specific&nbsp;contexts.<br>
+&nbsp;<br>
+Generally,&nbsp;this&nbsp;works&nbsp;by&nbsp;passing&nbsp;a&nbsp;set&nbsp;of&nbsp;keywords&nbsp;(strings)&nbsp;to<br>
+the&nbsp;colorscheme.get()&nbsp;method&nbsp;to&nbsp;receive&nbsp;the&nbsp;tuple&nbsp;(fg,&nbsp;bg,&nbsp;attr).<br>
+fg,&nbsp;bg&nbsp;are&nbsp;the&nbsp;foreground&nbsp;and&nbsp;background&nbsp;colors&nbsp;and&nbsp;attr&nbsp;is&nbsp;the&nbsp;attribute.<br>
+The&nbsp;values&nbsp;are&nbsp;specified&nbsp;in&nbsp;ranger.gui.color.<br>
+&nbsp;<br>
+A&nbsp;colorscheme&nbsp;must...<br>
+&nbsp;<br>
+1.&nbsp;be&nbsp;inside&nbsp;either&nbsp;of&nbsp;these&nbsp;directories:<br>
+~/.ranger/colorschemes/<br>
+path/to/ranger/colorschemes/<br>
+&nbsp;<br>
+2.&nbsp;be&nbsp;a&nbsp;subclass&nbsp;of&nbsp;ranger.gui.colorscheme.<a href="#ColorScheme">ColorScheme</a><br>
+&nbsp;<br>
+3.&nbsp;implement&nbsp;a&nbsp;use(self,&nbsp;context)&nbsp;method&nbsp;which&nbsp;returns&nbsp;(fg,&nbsp;bg,&nbsp;attr).<br>
+context&nbsp;is&nbsp;a&nbsp;struct&nbsp;which&nbsp;contains&nbsp;all&nbsp;entries&nbsp;of&nbsp;CONTEXT_KEYS,<br>
+associated&nbsp;with&nbsp;either&nbsp;True&nbsp;or&nbsp;False.<br>
+&nbsp;<br>
+define&nbsp;which&nbsp;colorscheme&nbsp;to&nbsp;use&nbsp;by&nbsp;having&nbsp;this&nbsp;to&nbsp;your&nbsp;options.py:<br>
+from&nbsp;ranger&nbsp;import&nbsp;colorschemes<br>
+colorscheme&nbsp;=&nbsp;colorschemes.filename<br>
+&nbsp;<br>
+If&nbsp;your&nbsp;colorscheme-file&nbsp;contains&nbsp;more&nbsp;than&nbsp;one&nbsp;colorscheme,&nbsp;specify&nbsp;it&nbsp;with:<br>
+colorscheme&nbsp;=&nbsp;colorschemes.filename.classname</tt></p>
 <p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#ee77aa">
@@ -31,13 +55,24 @@
 <td colspan=3 valign=bottom>&nbsp;<br>
 <font color="#000000" face="helvetica, arial"><a name="ColorScheme">class <strong>ColorScheme</strong></a>(<a href="builtins.html#object">builtins.object</a>)</font></td></tr>
     
-<tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
+<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
+<td colspan=2><tt>This&nbsp;is&nbsp;the&nbsp;class&nbsp;that&nbsp;colorschemes&nbsp;must&nbsp;inherit&nbsp;from.<br>
+&nbsp;<br>
+it&nbsp;defines&nbsp;<a href="#ColorScheme-get">get</a>()&nbsp;<br>
+it&nbsp;defines&nbsp;the&nbsp;<a href="#ColorScheme-get">get</a>()&nbsp;method,&nbsp;which&nbsp;returns&nbsp;the&nbsp;color&nbsp;tuple<br>
+which&nbsp;fits&nbsp;to&nbsp;the&nbsp;given&nbsp;keys.<br>&nbsp;</tt></td></tr>
+<tr><td>&nbsp;</td>
 <td width="100%">Methods defined here:<br>
 <dl><dt><a name="ColorScheme-__init__"><strong>__init__</strong></a>(self)</dt></dl>
 
-<dl><dt><a name="ColorScheme-get"><strong>get</strong></a>(self, *keys)</dt><dd><tt>Determine&nbsp;the&nbsp;(fg,&nbsp;bg,&nbsp;attr)&nbsp;tuple&nbsp;or&nbsp;get&nbsp;it&nbsp;from&nbsp;cache</tt></dd></dl>
+<dl><dt><a name="ColorScheme-get"><strong>get</strong></a>(self, *keys)</dt><dd><tt>Returns&nbsp;the&nbsp;(fg,&nbsp;bg,&nbsp;attr)&nbsp;for&nbsp;the&nbsp;given&nbsp;keys.<br>
+&nbsp;<br>
+Using&nbsp;this&nbsp;function&nbsp;rather&nbsp;than&nbsp;<a href="#ColorScheme-use">use</a>()&nbsp;will&nbsp;cache&nbsp;all<br>
+colors&nbsp;for&nbsp;faster&nbsp;access.</tt></dd></dl>
 
-<dl><dt><a name="ColorScheme-get_attr"><strong>get_attr</strong></a>(self, *keys)</dt><dd><tt>Returns&nbsp;the&nbsp;curses&nbsp;attr&nbsp;integer&nbsp;for&nbsp;the&nbsp;specified&nbsp;keys</tt></dd></dl>
+<dl><dt><a name="ColorScheme-get_attr"><strong>get_attr</strong></a>(self, *keys)</dt><dd><tt>Returns&nbsp;the&nbsp;curses&nbsp;attribute&nbsp;for&nbsp;the&nbsp;specified&nbsp;keys<br>
+&nbsp;<br>
+Ready&nbsp;to&nbsp;use&nbsp;for&nbsp;curses.setattr()</tt></dd></dl>
 
 <dl><dt><a name="ColorScheme-use"><strong>use</strong></a>(self, context)</dt><dd><tt>Use&nbsp;the&nbsp;colorscheme&nbsp;to&nbsp;determine&nbsp;the&nbsp;(fg,&nbsp;bg,&nbsp;attr)&nbsp;tuple.<br>
 This&nbsp;is&nbsp;a&nbsp;dummy&nbsp;function&nbsp;which&nbsp;always&nbsp;returns&nbsp;default_colors.<br>
@@ -58,5 +93,5 @@ Data descriptors defined here:<br>
 <font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
     
 <tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
-<td width="100%"><strong>CONTEXT_KEYS</strong> = ['reset', 'error', 'in_browser', 'in_statusbar', 'in_titlebar', 'in_console', 'in_notify', 'in_taskview', 'directory', 'file', 'hostname', 'executable', 'media', 'link', 'video', 'audio', 'image', 'media', 'document', 'container', ...]</td></tr></table>
+<td width="100%"><strong>CONTEXT_KEYS</strong> = ['reset', 'error', 'in_browser', 'in_statusbar', 'in_titlebar', 'in_console', 'in_pager', 'in_taskview', 'directory', 'file', 'hostname', 'executable', 'media', 'link', 'video', 'audio', 'image', 'media', 'document', 'container', ...]</td></tr></table>
 </body></html>
\ No newline at end of file