]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
- restored the previous API Reference structure
authorMike Bayer <mike_mp@zzzcomputing.com>
Mon, 8 Dec 2008 21:32:29 +0000 (21:32 +0000)
committerMike Bayer <mike_mp@zzzcomputing.com>
Mon, 8 Dec 2008 21:32:29 +0000 (21:32 +0000)
- bumped latex TOC structure, the PDF looks great
- but we need to fix the translate_connect_args docstring bug to really have PDF

doc/build/conf.py
doc/build/index.rst
lib/sqlalchemy/engine/url.py

index 20317a1164764d1b3a506e20e82d582fa95d49b6..0f4c5ff2aa0ef466e1505df7f9020432b9343270 100644 (file)
@@ -185,7 +185,7 @@ latex_documents = [
 
 # Additional stuff for the LaTeX preamble.
 # sets TOC depth to 2.
-latex_preamble = '\setcounter{tocdepth}{2}'
+latex_preamble = '\setcounter{tocdepth}{3}'
 
 # Documents to append as an appendix to all manuals.
 #latex_appendices = []
index f576324cddc925a114f06ef7cc1f3a3f653a0919..c3385d4e055abaf077773d099f37e9aeec69eda3 100644 (file)
@@ -10,18 +10,7 @@ Table of Contents
     session
     dbengine
     metadata
-
-API Documentation
------------------
-
-.. toctree::
-    :glob:
-    :maxdepth: 3
-
-    reference/sqlalchemy/index
-    reference/orm/index
-    reference/ext/index
-    reference/dialects/index
+    reference/index
 
 Indices and tables
 ------------------
index 035e2869354eb0c70787b2587d8f371247f4fb9c..679e4af89514b5b51faaa34e6f7c6da21100d4ad 100644 (file)
@@ -11,7 +11,8 @@ from sqlalchemy import exc
 
 
 class URL(object):
-    """Represent the components of a URL used to connect to a database.
+    """
+    Represent the components of a URL used to connect to a database.
 
     This object is suitable to be passed directly to a
     ``create_engine()`` call.  The fields of the URL are parsed from a
@@ -21,8 +22,8 @@ class URL(object):
     All initialization parameters are available as public attributes.
     
     :param drivername: the name of the database backend.  
-        This name will correspond to a module in sqlalchemy/databases 
-        or a third party plug-in.
+      This name will correspond to a module in sqlalchemy/databases 
+      or a third party plug-in.
 
     :param username: The user name.
 
@@ -35,7 +36,7 @@ class URL(object):
     :param database: The database name.
 
     :param query: A dictionary of options to be passed to the 
-        dialect and/or the DBAPI upon connect.
+      dialect and/or the DBAPI upon connect.
         
     """
 
@@ -102,9 +103,10 @@ 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:
 
+          .. sourcecode:: python
+        
             # return 'username' as 'user'
             username='user'