]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
improve some autodoc links
authorMike Bayer <mike_mp@zzzcomputing.com>
Wed, 31 Oct 2012 04:41:28 +0000 (00:41 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Wed, 31 Oct 2012 04:41:28 +0000 (00:41 -0400)
doc/build/core/engines.rst
doc/build/core/internals.rst
lib/sqlalchemy/engine/default.py
lib/sqlalchemy/engine/interfaces.py
lib/sqlalchemy/sql/compiler.py

index d243a94e16f97b7d69b642061090b2341bc0caf2..c4e497c92e9db9647db4a9638ed3d40b326f9905 100644 (file)
@@ -2,17 +2,17 @@
 Engine Configuration
 ====================
 
-The **Engine** is the starting point for any SQLAlchemy application. It's
+The :class:`.Engine` is the starting point for any SQLAlchemy application. It's
 "home base" for the actual database and its :term:`DBAPI`, delivered to the SQLAlchemy
-application through a connection pool and a **Dialect**, which describes how
+application through a connection pool and a :class:`.Dialect`, which describes how
 to talk to a specific kind of database/DBAPI combination.
 
 The general structure can be illustrated as follows:
 
 .. image:: sqla_engine_arch.png
 
-Where above, an :class:`~sqlalchemy.engine.Engine` references both a
-:class:`~sqlalchemy.engine.base.Dialect` and a :class:`~sqlalchemy.pool.Pool`,
+Where above, an :class:`.Engine` references both a
+:class:`.Dialect` and a :class:`.Pool`,
 which together interpret the DBAPI's module functions as well as the behavior
 of the database.
 
@@ -43,7 +43,7 @@ applications.
 Supported Databases
 ====================
 
-SQLAlchemy includes many :class:`~sqlalchemy.engine.base.Dialect` implementations for various
+SQLAlchemy includes many :class:`.Dialect` implementations for various
 backends.   Dialects for the most common databases are included with SQLAlchemy; a handful
 of others require an additional install of a separate dialect.
 
index e0b7f1b69dc0656733b2af71bb87f36796ce5e09..64dc34183eb4a65b3bacef6e04734df6c7f2491c 100644 (file)
@@ -7,10 +7,8 @@ Some key internal constructs are listed here.
 
 .. currentmodule: sqlalchemy
 
-.. autoclass:: sqlalchemy.engine.Compiled
+.. autoclass:: sqlalchemy.engine.interfaces.Compiled
     :members:
-    :undoc-members:
-    :show-inheritance:
 
 .. autoclass:: sqlalchemy.sql.compiler.DDLCompiler
     :members:
@@ -19,24 +17,18 @@ Some key internal constructs are listed here.
 
 .. autoclass:: sqlalchemy.engine.default.DefaultDialect
     :members:
-    :undoc-members:
     :show-inheritance:
     :inherited-members:
 
-.. autoclass:: sqlalchemy.engine.Dialect
+.. autoclass:: sqlalchemy.engine.interfaces.Dialect
     :members:
-    :undoc-members:
-    :show-inheritance:
-    :inherited-members:
 
 .. autoclass:: sqlalchemy.engine.default.DefaultExecutionContext
     :members:
-    :undoc-members:
     :show-inheritance:
 
-.. autoclass:: sqlalchemy.engine.ExecutionContext
+.. autoclass:: sqlalchemy.engine.interfaces.ExecutionContext
     :members:
-    :undoc-members:
     :show-inheritance:
 
 .. autoclass:: sqlalchemy.sql.compiler.IdentifierPreparer
index 1be7bc02937f343700e7fc421f699d2c8fce86e8..c536d1a4cd54421a5f754f875561bd69b4910fc8 100644 (file)
@@ -243,12 +243,12 @@ class DefaultDialect(interfaces.Dialect):
             return unicode_for_varchar
 
     def type_descriptor(self, typeobj):
-        """Provide a database-specific ``TypeEngine`` object, given
+        """Provide a database-specific :class:`.TypeEngine` object, given
         the generic object which comes from the types module.
 
         This method looks for a dictionary called
         ``colspecs`` as a class or instance-level variable,
-        and passes on to ``types.adapt_type()``.
+        and passes on to :func:`.types.adapt_type`.
 
         """
         return sqltypes.adapt_type(typeobj, self.colspecs)
index b1356489f8339100e0f95922cc1a0062a8198e6d..6d0b1cb611ef42e05e0c9610a7f4e4fc5805beca 100644 (file)
@@ -43,10 +43,10 @@ class Dialect(object):
       'utf-8'.
 
     statement_compiler
-      a :class:`~Compiled` class used to compile SQL statements
+      a :class:`.Compiled` class used to compile SQL statements
 
     ddl_compiler
-      a :class:`~Compiled` class used to compile DDL statements
+      a :class:`.Compiled` class used to compile DDL statements
 
     server_version_info
       a tuple containing a version number for the DB backend in use.
@@ -163,8 +163,8 @@ class Dialect(object):
         """Transform a generic type to a dialect-specific type.
 
         Dialect classes will usually use the
-        :func:`~sqlalchemy.types.adapt_type` function in the types module to
-        make this job easy.
+        :func:`.types.adapt_type` function in the types module to
+        accomplish this.
 
         The returned result is cached *per dialect class* so can
         contain no dialect-instance state.
@@ -244,7 +244,7 @@ class Dialect(object):
 
 
         Deprecated.  This method is only called by the default
-        implementation of :meth:`get_pk_constraint()`.  Dialects should
+        implementation of :meth:`.Dialect.get_pk_constraint`.  Dialects should
         instead implement this method directly.
 
         """
index 0847335c261fb1badda35076fe941d5b9a3b298e..74127c86a0c75d4e187deaa7b5bf110e16715de8 100644 (file)
@@ -8,17 +8,17 @@
 
 Classes provided include:
 
-:class:`~sqlalchemy.sql.compiler.SQLCompiler` - renders SQL
+:class:`.compiler.SQLCompiler` - renders SQL
 strings
 
-:class:`~sqlalchemy.sql.compiler.DDLCompiler` - renders DDL
+:class:`.compiler.DDLCompiler` - renders DDL
 (data definition language) strings
 
-:class:`~sqlalchemy.sql.compiler.GenericTypeCompiler` - renders
+:class:`.compiler.GenericTypeCompiler` - renders
 type specification strings.
 
 To generate user-defined SQL strings, see
-:module:`~sqlalchemy.ext.compiler`.
+:doc:`/ext/compiler`.
 
 """