- restored the previous API Reference structure

- bumped latex TOC structure, the PDF looks great
- but we need to fix the translate_connect_args docstring bug to really have PDF
This commit is contained in:
Mike Bayer
2008-12-08 21:32:29 +00:00
parent 3e2d6a9a18
commit 70f55bd2cd
3 changed files with 10 additions and 19 deletions
+1 -1
View 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 = []
+1 -12
View 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
------------------
+8 -6
View 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'