summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMike Bayer <mike_mp@zzzcomputing.com>2014-12-27 15:55:30 -0500
committerMike Bayer <mike_mp@zzzcomputing.com>2014-12-27 16:22:41 -0500
commit544e72bcb6af1ca657b1762f105634372eca3bc0 (patch)
treee574944f2b8e11ca5560188317f6611adac886c3 /doc
parentef6dc0cf2ef581e7cb53dcb4840f678aa1fa5ba6 (diff)
downloadsqlalchemy-544e72bcb6af1ca657b1762f105634372eca3bc0.tar.gz
- corrections
- attempt to add a script to semi-automate the fixing of links
Diffstat (limited to 'doc')
-rw-r--r--doc/build/changelog/changelog_09.rst15
-rw-r--r--doc/build/changelog/changelog_10.rst6
-rw-r--r--doc/build/changelog/migration_10.rst6
-rw-r--r--doc/build/conf.py3
-rw-r--r--doc/build/core/compiler.rst2
-rw-r--r--doc/build/core/custom_types.rst2
-rw-r--r--doc/build/core/exceptions.rst2
-rw-r--r--doc/build/core/sqla_engine_arch.pngbin28189 -> 28190 bytes
-rw-r--r--doc/build/core/types.rst2
-rw-r--r--doc/build/corrections.py39
-rw-r--r--doc/build/dialects/sqlite.rst2
-rw-r--r--doc/build/orm/collections.rst2
-rw-r--r--doc/build/orm/constructors.rst2
-rw-r--r--doc/build/orm/exceptions.rst2
-rw-r--r--doc/build/orm/extensions/associationproxy.rst2
-rw-r--r--doc/build/orm/extensions/mutable.rst2
-rw-r--r--doc/build/orm/internals.rst6
-rw-r--r--doc/build/orm/join_conditions.rst2
-rw-r--r--doc/build/orm/mapper_config.rst2
-rw-r--r--doc/build/orm/session_api.rst2
20 files changed, 77 insertions, 24 deletions
diff --git a/doc/build/changelog/changelog_09.rst b/doc/build/changelog/changelog_09.rst
index 7505ee50c..e0f46eb66 100644
--- a/doc/build/changelog/changelog_09.rst
+++ b/doc/build/changelog/changelog_09.rst
@@ -1,3 +1,4 @@
+
==============
0.9 Changelog
==============
@@ -314,7 +315,7 @@
:versions: 1.0.0
:pullrequest: bitbucket:28
- Fixed bug where :ref:`ext.mutable.MutableDict`
+ Fixed bug where :class:`.ext.mutable.MutableDict`
failed to implement the ``update()`` dictionary method, thus
not catching changes. Pull request courtesy Matt Chisholm.
@@ -323,9 +324,9 @@
:versions: 1.0.0
:pullrequest: bitbucket:27
- Fixed bug where a custom subclass of :ref:`ext.mutable.MutableDict`
+ Fixed bug where a custom subclass of :class:`.ext.mutable.MutableDict`
would not show up in a "coerce" operation, and would instead
- return a plain :ref:`ext.mutable.MutableDict`. Pull request
+ return a plain :class:`.ext.mutable.MutableDict`. Pull request
courtesy Matt Chisholm.
.. change::
@@ -577,7 +578,7 @@
:tickets: 3078
Added kw argument ``postgresql_regconfig`` to the
- :meth:`.Operators.match` operator, allows the "reg config" argument
+ :meth:`.ColumnOperators.match` operator, allows the "reg config" argument
to be specified to the ``to_tsquery()`` function emitted.
Pull request courtesy Jonathan Vanasco.
@@ -866,7 +867,7 @@
translated through some kind of SQL function or expression. This
is kind of experimental, but the first proof of concept is a
"materialized path" join condition where a path string is compared
- to itself using "like". The :meth:`.Operators.like` operator has
+ to itself using "like". The :meth:`.ColumnOperators.like` operator has
also been added to the list of valid operators to use in a primaryjoin
condition.
@@ -1939,8 +1940,8 @@
Fixed an issue where the C extensions in Py3K are using the wrong API
to specify the top-level module function, which breaks
in Python 3.4b2. Py3.4b2 changes PyMODINIT_FUNC to return
- "void" instead of "PyObject *", so we now make sure to use
- "PyMODINIT_FUNC" instead of "PyObject *" directly. Pull request
+ "void" instead of ``PyObject *``, so we now make sure to use
+ "PyMODINIT_FUNC" instead of ``PyObject *`` directly. Pull request
courtesy cgohlke.
.. change::
diff --git a/doc/build/changelog/changelog_10.rst b/doc/build/changelog/changelog_10.rst
index efd9d51d6..ceed4d912 100644
--- a/doc/build/changelog/changelog_10.rst
+++ b/doc/build/changelog/changelog_10.rst
@@ -147,7 +147,7 @@
:tags: bug, mysql
:tickets: 3263
- The :meth:`.Operators.match` operator is now handled such that the
+ The :meth:`.ColumnOperators.match` operator is now handled such that the
return type is not strictly assumed to be boolean; it now
returns a :class:`.Boolean` subclass called :class:`.MatchType`.
The type will still produce boolean behavior when used in Python
@@ -861,7 +861,7 @@
.. change::
:tags: bug, orm, py3k
- The :class:`.IdentityMap` exposed from :class:`.Session.identity`
+ The :class:`.IdentityMap` exposed from :class:`.Session.identity_map`
now returns lists for ``items()`` and ``values()`` in Py3K.
Early porting to Py3K here had these returning iterators, when
they technically should be "iterable views"..for now, lists are OK.
@@ -911,7 +911,7 @@
:tags: orm, feature
:tickets: 2971
- The :meth:`.InspectionAttr.info` collection is now moved down to
+ The :attr:`.InspectionAttr.info` collection is now moved down to
:class:`.InspectionAttr`, where in addition to being available
on all :class:`.MapperProperty` objects, it is also now available
on hybrid properties, association proxies, when accessed via
diff --git a/doc/build/changelog/migration_10.rst b/doc/build/changelog/migration_10.rst
index 717f31aff..829d04c51 100644
--- a/doc/build/changelog/migration_10.rst
+++ b/doc/build/changelog/migration_10.rst
@@ -905,7 +905,7 @@ as all the subclasses normally refer to the same table::
-.. _migration_migration_deprecated_orm_events:
+.. _migration_deprecated_orm_events:
Deprecated ORM Event Hooks Removed
----------------------------------
@@ -1624,7 +1624,7 @@ again works on MySQL.
The match() operator now returns an agnostic MatchType compatible with MySQL's floating point return value
----------------------------------------------------------------------------------------------------------
-The return type of a :meth:`.Operators.match` expression is now a new type
+The return type of a :meth:`.ColumnOperators.match` expression is now a new type
called :class:`.MatchType`. This is a subclass of :class:`.Boolean`,
that can be intercepted by the dialect in order to produce a different
result type at SQL execution time.
@@ -1669,8 +1669,6 @@ on polishing it.
Dialect Improvements and Changes - SQLite
=============================================
-.. _change_2984:
-
SQLite named and unnamed UNIQUE and FOREIGN KEY constraints will inspect and reflect
-------------------------------------------------------------------------------------
diff --git a/doc/build/conf.py b/doc/build/conf.py
index 7e17fcd59..02784bdae 100644
--- a/doc/build/conf.py
+++ b/doc/build/conf.py
@@ -37,6 +37,7 @@ extensions = [
'zzzeeksphinx',
'changelog',
'sphinx_paramlinks',
+ 'corrections'
]
# Add any paths that contain templates here, relative to this directory.
@@ -341,3 +342,5 @@ intersphinx_mapping = {
'alembic': ('http://alembic.readthedocs.org/en/latest/', None),
'psycopg2': ('http://pythonhosted.org/psycopg2', None),
}
+
+
diff --git a/doc/build/core/compiler.rst b/doc/build/core/compiler.rst
index 73c9e3995..202ef2b0e 100644
--- a/doc/build/core/compiler.rst
+++ b/doc/build/core/compiler.rst
@@ -4,4 +4,4 @@ Custom SQL Constructs and Compilation Extension
===============================================
.. automodule:: sqlalchemy.ext.compiler
- :members: \ No newline at end of file
+ :members:
diff --git a/doc/build/core/custom_types.rst b/doc/build/core/custom_types.rst
index 92c5ca6cf..8d0c42703 100644
--- a/doc/build/core/custom_types.rst
+++ b/doc/build/core/custom_types.rst
@@ -1,3 +1,5 @@
+.. module:: sqlalchemy.types
+
.. _types_custom:
Custom Types
diff --git a/doc/build/core/exceptions.rst b/doc/build/core/exceptions.rst
index 30270f8b0..63bbc1e15 100644
--- a/doc/build/core/exceptions.rst
+++ b/doc/build/core/exceptions.rst
@@ -2,4 +2,4 @@ Core Exceptions
===============
.. automodule:: sqlalchemy.exc
- :members: \ No newline at end of file
+ :members:
diff --git a/doc/build/core/sqla_engine_arch.png b/doc/build/core/sqla_engine_arch.png
index f54d105bd..f040a2cf3 100644
--- a/doc/build/core/sqla_engine_arch.png
+++ b/doc/build/core/sqla_engine_arch.png
Binary files differ
diff --git a/doc/build/core/types.rst b/doc/build/core/types.rst
index 9d2b66124..ab761a1cb 100644
--- a/doc/build/core/types.rst
+++ b/doc/build/core/types.rst
@@ -8,4 +8,4 @@ Column and Data Types
type_basics
custom_types
- type_api \ No newline at end of file
+ type_api
diff --git a/doc/build/corrections.py b/doc/build/corrections.py
new file mode 100644
index 000000000..fa2e13a38
--- /dev/null
+++ b/doc/build/corrections.py
@@ -0,0 +1,39 @@
+targets = {}
+quit = False
+def missing_reference(app, env, node, contnode):
+ global quit
+ if quit:
+ return
+ reftarget = node.attributes['reftarget']
+ reftype = node.attributes['reftype']
+ refdoc = node.attributes['refdoc']
+ rawsource = node.rawsource
+ if reftype == 'paramref':
+ return
+
+ target = rawsource
+ if target in targets:
+ return
+ print "\n%s" % refdoc
+ print "Reftarget: %s" % rawsource
+ correction = raw_input("? ")
+ correction = correction.strip()
+ if correction == ".":
+ correction = ":%s:`.%s`" % (reftype, reftarget)
+ elif correction == 'q':
+ quit = True
+ else:
+ targets[target] = correction
+
+def write_corrections(app, exception):
+ print "#!/bin/sh\n\n"
+ for targ, corr in targets.items():
+ if not corr:
+ continue
+
+ print """find lib/ -print -type f -name "*.py" -exec sed -i '' 's/%s/%s/g' {} \;""" % (targ, corr)
+ print """find doc/build/ -print -type f -name "*.rst" -exec sed -i '' 's/%s/%s/g' {} \;""" % (targ, corr)
+
+def setup(app):
+ app.connect('missing-reference', missing_reference)
+ app.connect('build-finished', write_corrections)
diff --git a/doc/build/dialects/sqlite.rst b/doc/build/dialects/sqlite.rst
index a18b0ba7b..93a54ee8d 100644
--- a/doc/build/dialects/sqlite.rst
+++ b/doc/build/dialects/sqlite.rst
@@ -33,4 +33,4 @@ Pysqlite
Pysqlcipher
-----------
-.. automodule:: sqlalchemy.dialects.sqlite.pysqlcipher \ No newline at end of file
+.. automodule:: sqlalchemy.dialects.sqlite.pysqlcipher
diff --git a/doc/build/orm/collections.rst b/doc/build/orm/collections.rst
index 898f70ebb..7d474ce65 100644
--- a/doc/build/orm/collections.rst
+++ b/doc/build/orm/collections.rst
@@ -573,7 +573,7 @@ Various internal methods.
.. autoclass:: collection
-.. autofunction:: collection_adapter
+.. autodata:: collection_adapter
.. autoclass:: CollectionAdapter
diff --git a/doc/build/orm/constructors.rst b/doc/build/orm/constructors.rst
index ab6691553..38cbb4182 100644
--- a/doc/build/orm/constructors.rst
+++ b/doc/build/orm/constructors.rst
@@ -1,3 +1,5 @@
+.. module:: sqlalchemy.orm
+
.. _mapping_constructors:
Constructors and Object Initialization
diff --git a/doc/build/orm/exceptions.rst b/doc/build/orm/exceptions.rst
index f95b26eed..047c743e0 100644
--- a/doc/build/orm/exceptions.rst
+++ b/doc/build/orm/exceptions.rst
@@ -2,4 +2,4 @@ ORM Exceptions
==============
.. automodule:: sqlalchemy.orm.exc
- :members: \ No newline at end of file
+ :members:
diff --git a/doc/build/orm/extensions/associationproxy.rst b/doc/build/orm/extensions/associationproxy.rst
index 9b25c4a68..6fc57e30c 100644
--- a/doc/build/orm/extensions/associationproxy.rst
+++ b/doc/build/orm/extensions/associationproxy.rst
@@ -510,4 +510,4 @@ API Documentation
:members:
:undoc-members:
-.. autodata:: ASSOCIATION_PROXY \ No newline at end of file
+.. autodata:: ASSOCIATION_PROXY
diff --git a/doc/build/orm/extensions/mutable.rst b/doc/build/orm/extensions/mutable.rst
index 14875cd3c..969411481 100644
--- a/doc/build/orm/extensions/mutable.rst
+++ b/doc/build/orm/extensions/mutable.rst
@@ -21,7 +21,7 @@ API Reference
.. autoclass:: MutableDict
:members:
-
+ :undoc-members:
diff --git a/doc/build/orm/internals.rst b/doc/build/orm/internals.rst
index 78ec2fa8e..4b6802394 100644
--- a/doc/build/orm/internals.rst
+++ b/doc/build/orm/internals.rst
@@ -11,6 +11,9 @@ sections, are listed here.
.. autoclass:: sqlalchemy.orm.state.AttributeState
:members:
+.. autoclass:: sqlalchemy.orm.util.CascadeOptions
+ :members:
+
.. autoclass:: sqlalchemy.orm.instrumentation.ClassManager
:members:
:inherited-members:
@@ -19,6 +22,9 @@ sections, are listed here.
:members:
:inherited-members:
+.. autoclass:: sqlalchemy.orm.properties.ComparableProperty
+ :members:
+
.. autoclass:: sqlalchemy.orm.descriptor_props.CompositeProperty
:members:
diff --git a/doc/build/orm/join_conditions.rst b/doc/build/orm/join_conditions.rst
index 5e2c11d1d..c39b7312e 100644
--- a/doc/build/orm/join_conditions.rst
+++ b/doc/build/orm/join_conditions.rst
@@ -462,7 +462,7 @@ we seek for a load of ``Element.descendants`` to look like::
.. versionadded:: 0.9.5 Support has been added to allow a single-column
comparison to itself within a primaryjoin condition, as well as for
- primaryjoin conditions that use :meth:`.Operators.like` as the comparison
+ primaryjoin conditions that use :meth:`.ColumnOperators.like` as the comparison
operator.
.. _self_referential_many_to_many:
diff --git a/doc/build/orm/mapper_config.rst b/doc/build/orm/mapper_config.rst
index 671abdfd6..9d584cbab 100644
--- a/doc/build/orm/mapper_config.rst
+++ b/doc/build/orm/mapper_config.rst
@@ -18,4 +18,4 @@ know how to construct and use rudimentary mappers and relationships.
nonstandard_mappings
classical
versioning
- mapping_api \ No newline at end of file
+ mapping_api
diff --git a/doc/build/orm/session_api.rst b/doc/build/orm/session_api.rst
index 64ac8c086..3754ac80b 100644
--- a/doc/build/orm/session_api.rst
+++ b/doc/build/orm/session_api.rst
@@ -1,3 +1,5 @@
+.. module:: sqlalchemy.orm.session
+
Session API
============