call attention to note about coordinate systems and add stylesheet to highlight attention directive

Tony S Yu · Tony S Yu · commit 6083ec2ed7e0 · 2009-07-19T11:38:12.000-04:00
diff --git a/doc/source/_static/quantities.css b/doc/source/_static/quantities.css
@@ -0,0 +1,6 @@
+@import "sphinxdoc.css";
+
+div.attention p.admonition-title {
+    color: black;
+    background-color: #FFF305;
+}
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -91,6 +91,7 @@
 # must exist either in Sphinx' static/ path, or in one of the custom paths
 # given in html_static_path.
 html_theme = 'sphinxdoc'
+html_style = 'quantities.css'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
diff --git a/quantities/__init__.py b/quantities/__init__.py
@@ -221,12 +221,19 @@
 When unicode is enabled, strings used to designate units should still
 conform to valid python expressions.
 
-One final note: Quantities is not a package for describing coordinate
-systems that require a point of reference, like positions on a map or
-absolute temperature scales. Proper support of coordinate systems
-would be a fairly large undertaking and is outside the scope of this
-project.
-
+.. attention::
+   Quantities is not a package for describing coordinate systems that require a
+   point of reference, like positions on a map. In particular, Quantities does
+   not support absolute temperature scales. Instead, temperatures are assumed to
+   be temperature *differences*. For example:
+   
+   >>> T = 20 * pq.degC
+   >>> print T.rescale('K')
+   20.0 K
+   
+   Proper support of coordinate systems would be a fairly large undertaking and
+   is outside the scope of this project.
+   
 """
 
 #from __future__ import absolute_import
