Update theme paths and sample themes and the documentation

sebastinas · sebastinas · commit 828f2d1761ba · 2013-09-06T20:54:21.000+02:00
Signed-off-by: Sebastian Ramacher &lt;sebastian+dev@ramacher.at&gt;
diff --git a/doc/sphinx/source/themes.rst b/doc/sphinx/source/themes.rst
@@ -4,11 +4,11 @@ Themes
 ======
 This chapter is about bpython's themeing capabalities.
 
-bpython uses .theme files placed in your ~/.bpython directory. You can set the
-theme in the :ref:`configuration_color_scheme` option in your
-`~/bpython/config`` file (:ref:`configuration`). You can find some of our
-themes in our gallery on our website:
-http://bpython-interpreter.org/themes/
+bpython uses .theme files placed in your ``$XDG_CONFIG_HOME/bpython`` directory
+[#f1]_.  You can set the theme in the :ref:`configuration_color_scheme` option
+in your ``$XDG_CONFIG_HOME/bpython/config`` file (:ref:`configuration`). You can
+find some of our themes in our gallery on our website:
+`<http://bpython-interpreter.org/themes/>`_
 
 Available Colors
 ----------------
@@ -53,7 +53,8 @@ The default theme included in bpython is as follows:
   # which stands for:
   #   blacK, Red, Green, Yellow, Blue, Magenta, Cyan, White, Default
   # Capital letters represent bold
-  # Copy to ~/.bpython/foo.theme and set "color_scheme = foo" in ~/bpython/config
+  # Copy to $XDG_CONFIG_HOME/bpython/foo.theme and set "color_scheme = foo" in
+  # $XDG_CONFIG_HOME/bpython/config ($XDG_CONFIG_HOME defaults to ~/.config)
 
   [syntax]
   keyword = y
@@ -66,7 +67,7 @@ The default theme included in bpython is as follows:
   punctuation = y
   token = C
   paren = R
-  
+
   [interface]
   # XXX: gnome-terminal appears to be braindead. The cursor will disappear unless
   # you set the background colour to "d".
@@ -76,3 +77,7 @@ The default theme included in bpython is as follows:
   prompt = c
   prompt_more = g
 
+.. :: Footnotes
+
+.. [#f1] ``$XDG_CONFIG_HOME`` defaults to ``~/.config`` if not set.
+
diff --git a/light.theme b/light.theme
@@ -3,8 +3,8 @@
 # which stands for:
 #   blacK, Red, Green, Yellow, Blue, Magenta, Cyan, White, Default
 # Capital letters represent bold
-# Copy to ~/.bpython/foo.theme and set "color_scheme = foo" in
-# ~/.bpython/config
+# Copy to $XDG_CONFIG_HOME/bpython/foo.theme and set "color_scheme = foo" in
+# $XDG_CONFIG_HOME/bpython/config ($XDG_CONFIG_HOME defaults to ~/.config)
 
 [syntax]
 keyword = M
diff --git a/sample-config b/sample-config
@@ -1,7 +1,8 @@
 # This is a standard python config file
 # Valid values can be True, False, integer numbers, strings
-# By default bpython will look for ~/.config/bpython/config or you
-# can specify a file with the --config option on the command line
+# By default bpython will look for $XDG_CONFIG_HOME/bpython/config
+# ($XDG_CONFIG_HOME defaults to ~/.config) or you can specify a file with the
+# --config option on the command line
 
 # General section tag
 [general]
@@ -26,9 +27,9 @@ hist_length = 100
 # Soft tab size (default: 4, see pep-8):
 tab_length = 4
 
-# Color schemes should be put in ~/.bpython/
-# e.g. to use the theme ~/.bpython/foo.theme set color_scheme = foo
-# Leave blank or set to "default" to use the default theme
+# Color schemes should be put in $XDG_CONFIG_HOME/bpython/ e.g. to use the theme
+# $XDG_CONFIG_HOME/bpython/foo.theme set color_scheme = foo. Leave blank or set
+# to "default" to use the default theme
 color_scheme = default
 
 [keyboard]
diff --git a/sample.theme b/sample.theme
@@ -3,7 +3,8 @@
 # which stands for:
 #   blacK, Red, Green, Yellow, Blue, Magenta, Cyan, White, Default
 # Capital letters represent bold
-# Copy to ~/.bpython/foo.theme and set "color_scheme = foo" in ~/.bython/config
+# Copy to $XDG_CONFIG_HOME/bpython/foo.theme and set "color_scheme = foo" in
+# $XDG_CONFIG_HOME/bpython/config ($XDG_CONFIG_HOME defaults to ~/.config)
 
 [syntax]
 keyword = y
