# 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 = []
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
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.
: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.
"""
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'