]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
corrections
authorMike Bayer <mike_mp@zzzcomputing.com>
Sat, 27 Dec 2014 21:54:32 +0000 (16:54 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Sat, 27 Dec 2014 21:58:53 +0000 (16:58 -0500)
(cherry picked from commit 5343d24fee5219de002a8efba8bc882f8b3d4b5b)

14 files changed:
doc/build/conf.py
doc/build/core/connections.rst
doc/build/core/constraints.rst
doc/build/core/ddl.rst
doc/build/core/functions.rst
doc/build/core/internals.rst
doc/build/orm/internals.rst
lib/sqlalchemy/dialects/postgresql/base.py
lib/sqlalchemy/engine/__init__.py
lib/sqlalchemy/engine/base.py
lib/sqlalchemy/ext/hybrid.py
lib/sqlalchemy/schema.py
lib/sqlalchemy/sql/ddl.py
lib/sqlalchemy/sql/type_api.py

index 78ee36b1e425391a616e175226bac1089de2bd8e..8645ffd4527b9edc339959d608cbbe4ac222b0d6 100644 (file)
@@ -37,7 +37,7 @@ extensions = [
                 'zzzeeksphinx',
                 'changelog',
                 'sphinx_paramlinks',
-                'corrections'
+                #'corrections'
             ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -79,7 +79,9 @@ autodocmods_convert_modname = {
     "sqlalchemy.sql.selectable": "sqlalchemy.sql.expression",
     "sqlalchemy.sql.dml": "sqlalchemy.sql.expression",
     "sqlalchemy.sql.ddl": "sqlalchemy.schema",
-    "sqlalchemy.sql.base": "sqlalchemy.sql.expression"
+    "sqlalchemy.sql.base": "sqlalchemy.sql.expression",
+    "sqlalchemy.engine.base": "sqlalchemy.engine",
+    "sqlalchemy.engine.result": "sqlalchemy.engine",
 }
 
 autodocmods_convert_modname_w_class = {
@@ -192,7 +194,7 @@ html_title = "%s %s Documentation" % (project, version)
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['static']
+html_static_path = []
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
index 248309a2e3169e86791e329fd6dae4b97118bced..bb04b9496fdcc88457d02559e683c514be536d8c 100644 (file)
@@ -559,6 +559,9 @@ The above will respond to ``create_engine("mysql+foodialect://")`` and load the
 Connection / Engine API
 =======================
 
+.. autoclass:: BaseRowProxy
+    :members:
+
 .. autoclass:: Connection
    :members:
 
@@ -568,16 +571,16 @@ Connection / Engine API
 .. autoclass:: Engine
    :members:
 
-.. autoclass:: sqlalchemy.engine.ExceptionContext
+.. autoclass:: ExceptionContext
    :members:
 
 .. autoclass:: NestedTransaction
     :members:
 
-.. autoclass:: sqlalchemy.engine.ResultProxy
+.. autoclass:: ResultProxy
     :members:
 
-.. autoclass:: sqlalchemy.engine.RowProxy
+.. autoclass:: RowProxy
     :members:
 
 .. autoclass:: Transaction
index 554d003bb85670a87e90e962007deae2e910dd32..15d0405fe9e55d09afb0cf5846e2951e3b90b530 100644 (file)
@@ -7,11 +7,11 @@
 Defining Constraints and Indexes
 =================================
 
-.. _metadata_foreignkeys:
-
 This section will discuss SQL :term:`constraints` and indexes.  In SQLAlchemy
 the key classes include :class:`.ForeignKeyConstraint` and :class:`.Index`.
 
+.. _metadata_foreignkeys:
+
 Defining Foreign Keys
 ---------------------
 
index cee6f876e5ebf4ed1a0ed6d6492c771bd15e9788..6607ac9f8a1cde7ca0150368152856deaeb31fa0 100644 (file)
@@ -223,65 +223,72 @@ DDL Expression Constructs API
 .. autoclass:: DDLElement
     :members:
     :undoc-members:
-     
+
 
 .. autoclass:: DDL
     :members:
     :undoc-members:
-     
+
+
+.. autoclass:: _DDLCompiles
+    :members:
+
+
+.. autoclass:: _CreateDropBase
+    :members:
 
 .. autoclass:: CreateTable
     :members:
     :undoc-members:
-     
+
 
 .. autoclass:: DropTable
     :members:
     :undoc-members:
-     
+
 
 .. autoclass:: CreateColumn
     :members:
     :undoc-members:
-     
+
 
 .. autoclass:: CreateSequence
     :members:
     :undoc-members:
-     
+
 
 .. autoclass:: DropSequence
     :members:
     :undoc-members:
-     
+
 
 .. autoclass:: CreateIndex
     :members:
     :undoc-members:
-     
+
 
 .. autoclass:: DropIndex
     :members:
     :undoc-members:
-     
+
 
 .. autoclass:: AddConstraint
     :members:
     :undoc-members:
-     
+
 
 .. autoclass:: DropConstraint
     :members:
     :undoc-members:
-     
+
 
 .. autoclass:: CreateSchema
     :members:
     :undoc-members:
-     
+
 
 .. autoclass:: DropSchema
     :members:
     :undoc-members:
-     
+
 
index d284d125f4640ba0ab98b6cdbe9f33735055fb39..90164850d4cb8a60915a75dae413fa3f4bfdf881 100644 (file)
@@ -22,6 +22,7 @@ return types are in use.
 .. automodule:: sqlalchemy.sql.functions
    :members:
    :undoc-members:
-    
+   :exclude-members: func
+
 
 
index 1a85e9e6c62fee74502edcd5dcd7c8793914b3d8..81b4f1a81a3de44c7808aeb2b68460195a26e2f5 100644 (file)
@@ -7,6 +7,9 @@ Some key internal constructs are listed here.
 
 .. currentmodule: sqlalchemy
 
+.. autoclass:: sqlalchemy.schema.ColumnCollectionMixin
+    :members:
+
 .. autoclass:: sqlalchemy.engine.interfaces.Compiled
     :members:
 
@@ -29,6 +32,10 @@ Some key internal constructs are listed here.
     :members:
 
 
+.. autoclass:: sqlalchemy.log.Identified
+    :members:
+
+
 .. autoclass:: sqlalchemy.sql.compiler.IdentifierPreparer
     :members:
 
index c08c8a2275827c3945713e4bf1c5a7858bbbbab5..b37d3547048dcf362073822a018ae753e1a87e1b 100644 (file)
@@ -32,10 +32,11 @@ sections, are listed here.
 .. autoclass:: sqlalchemy.orm.attributes.Event
     :members:
 
-
 .. autoclass:: sqlalchemy.orm.interfaces._InspectionAttr
     :members:
 
+.. autoclass:: sqlalchemy.orm.identity.IdentityMap
+    :members:
 
 .. autoclass:: sqlalchemy.orm.state.InstanceState
     :members:
index defce5414dd33b2c0b9fb1b218b2b340b3f0d5e3..1efb03d3ca3eb3ab827bafae4f65b7feddc391a1 100644 (file)
@@ -266,7 +266,7 @@ will emit to the database::
 
 The Postgresql text search functions such as ``to_tsquery()``
 and ``to_tsvector()`` are available
-explicitly using the standard :attr:`.func` construct.  For example::
+explicitly using the standard :data:`.func` construct.  For example::
 
     select([
         func.to_tsvector('fat cats ate rats').match('cat & rat')
index cf75871bfd2edaaf32d06c1e024c083f6392423f..3857bdf1e72622bc2521c1ac14f65880f485c7ab 100644 (file)
@@ -72,6 +72,7 @@ from .base import (
 )
 
 from .result import (
+    BaseRowProxy,
     BufferedColumnResultProxy,
     BufferedColumnRow,
     BufferedRowResultProxy,
index cbaa4f04884ecc5573224753068728552f9236be..e691bb6209a00be439f98a182838393419a4e8c7 100644 (file)
@@ -670,7 +670,7 @@ class Connection(Connectable):
            a subclass of :class:`.Executable`, such as a
            :func:`~.expression.select` construct
          * a :class:`.FunctionElement`, such as that generated
-           by :attr:`.func`, will be automatically wrapped in
+           by :data:`.func`, will be automatically wrapped in
            a SELECT statement, which is then executed.
          * a :class:`.DDLElement` object
          * a :class:`.DefaultGenerator` object
index 9f4e09e9261863500b64527413d806861038206d..f58348c895c4543a54c5f6a1a9c3bfa9d15ead2d 100644 (file)
@@ -145,7 +145,7 @@ usage of the absolute value function::
             return func.abs(cls.length) / 2
 
 Above the Python function ``abs()`` is used for instance-level
-operations, the SQL function ``ABS()`` is used via the :attr:`.func`
+operations, the SQL function ``ABS()`` is used via the :data:`.func`
 object for class-level expressions::
 
     >>> i1.radius
index 4b6ad19884d0a9642171fa20cb98ecf9069ff79d..95ebd05db7a3f54059d2d62235b3d7cd5ef1468e 100644 (file)
@@ -35,6 +35,7 @@ from .sql.schema import (
     UniqueConstraint,
     _get_table_key,
     ColumnCollectionConstraint,
+    ColumnCollectionMixin
     )
 
 
index 1f2c448ea067b14eec023d97382d1ce87c17070f..534322c8d1a2170ef5e8b6fb09c6ee4b54fba1e2 100644 (file)
@@ -370,7 +370,7 @@ class DDL(DDLElement):
 
             :class:`.DDLEvents`
 
-            :mod:`sqlalchemy.event`
+            :ref:`event_toplevel`
 
         """
 
index 691ef9802af73b6ca7a713739d062ace9d847b51..e70c793dc08d7d2af0f8777a765eb08725912e28 100644 (file)
@@ -252,7 +252,7 @@ class TypeEngine(Visitable):
         The construction of :meth:`.TypeEngine.with_variant` is always
         from the "fallback" type to that which is dialect specific.
         The returned type is an instance of :class:`.Variant`, which
-        itself provides a :meth:`~sqlalchemy.types.Variant.with_variant`
+        itself provides a :meth:`.Variant.with_variant`
         that can be called repeatedly.
 
         :param type_: a :class:`.TypeEngine` that will be selected