]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
- moved index.rst around to have the API docs right there, no "Main Documentation...
authorMike Bayer <mike_mp@zzzcomputing.com>
Sun, 7 Dec 2008 23:58:02 +0000 (23:58 +0000)
committerMike Bayer <mike_mp@zzzcomputing.com>
Sun, 7 Dec 2008 23:58:02 +0000 (23:58 +0000)
- added LatexFormatter.
- PDF wont work until issue with the docstirng in url.py/URL.translate_connect_args is fixed.

doc/build/builder/builders.py
doc/build/index.rst
doc/build/reference/sqlalchemy/connections.rst
lib/sqlalchemy/engine/url.py

index f65678ce2de6bfe0ba024829fe2c73fb48bdec28..a7fb45998be8ddadc6142cfb3fc9355eae938e71 100644 (file)
@@ -122,10 +122,24 @@ class PopupSQLFormatter(HtmlFormatter):
         for t, v in _strip_trailing_whitespace(HtmlFormatter._format_lines(self, iter(buf))):
             yield t, v
 
+class PopupLatexFormatter(LatexFormatter):
+    def _filter_tokens(self, tokensource):
+        for ttype, value in apply_filters(tokensource, [StripDocTestFilter()]):
+            if ttype in Token.Sql:
+                if ttype is not Token.Sql.Link and ttype is not Token.Sql.Open:
+                    yield Token.Literal, re.sub(r'(?:[{stop}|\n]*)$', '', value)
+                else:
+                    continue
+            else:
+                yield ttype, value
+        
+    def format(self, tokensource, outfile):
+        LatexFormatter.format(self, self._filter_tokens(tokensource), outfile)
+
 def setup(app):
     app.add_lexer('pycon+sql', PyConWithSQLLexer())
     app.add_lexer('python+sql', PythonWithSQLLexer())
     PygmentsBridge.html_formatter = PopupSQLFormatter
-    #PygmentsBridge.latex_formatter = LatexFormatter
+    PygmentsBridge.latex_formatter = PopupLatexFormatter
     
     
\ No newline at end of file
index ed33dfbe59965e6cedf81c8f97017f682a7ac9b3..f576324cddc925a114f06ef7cc1f3a3f653a0919 100644 (file)
@@ -1,11 +1,7 @@
 Table of Contents
 =================
 
-Main Documentation
-------------------
-
 .. toctree::
-    :glob:
 
     intro
     ormtutorial
@@ -14,8 +10,19 @@ Main Documentation
     session
     dbengine
     metadata
-    reference/index
-    
+
+API Documentation
+-----------------
+
+.. toctree::
+    :glob:
+    :maxdepth: 3
+
+    reference/sqlalchemy/index
+    reference/orm/index
+    reference/ext/index
+    reference/dialects/index
+
 Indices and tables
 ------------------
 
index 877b73231cced8a23a95ffb827eac2f47b09dd30..2f861816c3d2713564846bd257c7d64f69150332 100644 (file)
@@ -10,7 +10,7 @@ Creating Engines
 
 .. autoclass:: sqlalchemy.engine.url.URL
     :members:
-    
+
 Connectables
 ------------
 
index e00efd6c01946896bcfc077f460c930b907f2cd3..5d5ce0bd0f669ef5fe086d2b51c083a31ac40dc0 100644 (file)
@@ -102,14 +102,13 @@ class URL(object):
         used as the keys by default.  Unset or false attributes are omitted
         from the final dictionary.
 
-        :param \**kw: Optional, alternate key names for url 
-            attributes::
+        :param \**kw: Optional, alternate key names for url attributes::
 
-                # return 'username' as 'user'
-                username='user'
+          # return 'username' as 'user'
+          username='user'
 
-                # omit 'database'
-                database=None
+          # omit 'database'
+          database=None
         
         :param names: Deprecated.  Same purpose as the keyword-based alternate names,
             but correlates the name to the original positionally.