]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
Fix almost all read-level sphinx warnings
authorMike Bayer <mike_mp@zzzcomputing.com>
Sat, 11 Apr 2020 17:53:41 +0000 (13:53 -0400)
committerMike Bayer <mike_mp@zzzcomputing.com>
Sat, 11 Apr 2020 17:56:06 +0000 (13:56 -0400)
Partial backport of 43bcb0de1ecc1dc2abd7e7c3eb0c39f3eab9adc0.

Also enables sphinx multiprocess.

Change-Id: I49b1959b9a5fe84fb4c74366da2724284a804936
(cherry picked from commit d56887bcb63808ff6b42e4370ec082a8ef5a41a0)
(cherry picked from commit 17feac57cde73bda9fb5b335fa9b3e62aa5cadad)

32 files changed:
doc/build/Makefile
doc/build/changelog/changelog_07.rst
doc/build/changelog/changelog_08.rst
doc/build/changelog/changelog_09.rst
doc/build/changelog/changelog_10.rst
doc/build/changelog/changelog_11.rst
doc/build/changelog/migration_08.rst
doc/build/core/constraints.rst
doc/build/core/custom_types.rst
doc/build/core/ddl.rst
doc/build/core/defaults.rst
doc/build/core/dml.rst
doc/build/core/functions.rst
doc/build/core/reflection.rst
doc/build/core/schema.rst
doc/build/core/selectable.rst
doc/build/core/sqlelement.rst
doc/build/core/type_api.rst
doc/build/orm/collections.rst
doc/build/orm/composites.rst
doc/build/orm/constructors.rst
doc/build/orm/loading_columns.rst
doc/build/orm/mapped_attributes.rst
doc/build/orm/mapped_sql_expr.rst
doc/build/orm/mapping_api.rst
doc/build/orm/mapping_columns.rst
doc/build/orm/query.rst
doc/build/orm/relationship_api.rst
doc/build/orm/relationships.rst
doc/build/orm/scalar_mapping.rst
doc/build/orm/session_api.rst
lib/sqlalchemy/sql/base.py

index cd39b7288820287fdafa222d15f8ff7f51402d62..58fdc6c162f9981d9049560caa8319e63bc292c2 100644 (file)
@@ -2,7 +2,7 @@
 #
 
 # You can set these variables from the command line.
-SPHINXOPTS    = -v
+SPHINXOPTS    = -j auto -v
 SPHINXBUILD   = sphinx-build
 PAPER         =
 BUILDDIR      = output
index 2b7654ec2e2f98f278e3d2dde8b83b998e8b101d..355894004218456ed43368b5d0ad040fd533ec82 100644 (file)
@@ -1,62 +1,62 @@
-
 =============
 0.7 Changelog
 =============
 
 .. changelog::
     :version: 0.7.11
+    :released:
 
     .. change::
         :tags: bug, engine
         :tickets: 2851
         :versions: 0.8.3, 0.9.0b1
 
-        The regexp used by the :func:`~sqlalchemy.engine.url.make_url` function now parses
-        ipv6 addresses, e.g. surrounded by brackets.
+      The regexp used by the :func:`~sqlalchemy.engine.url.make_url` function now parses
+      ipv6 addresses, e.g. surrounded by brackets.
 
     .. change::
         :tags: bug, orm
         :tickets: 2807
         :versions: 0.8.3, 0.9.0b1
 
-        Fixed bug where list instrumentation would fail to represent a
-        setslice of ``[0:0]`` correctly, which in particular could occur
-        when using ``insert(0, item)`` with the association proxy.  Due
-        to some quirk in Python collections, the issue was much more likely
-        with Python 3 rather than 2.
+      Fixed bug where list instrumentation would fail to represent a
+      setslice of ``[0:0]`` correctly, which in particular could occur
+      when using ``insert(0, item)`` with the association proxy.  Due
+      to some quirk in Python collections, the issue was much more likely
+      with Python 3 rather than 2.
 
     .. change::
         :tags: bug, sql
         :tickets: 2801
         :versions: 0.8.3, 0.9.0b1
 
-        Fixed regression dating back to 0.7.9 whereby the name of a CTE might
-        not be properly quoted if it was referred to in multiple FROM clauses.
+      Fixed regression dating back to 0.7.9 whereby the name of a CTE might
+      not be properly quoted if it was referred to in multiple FROM clauses.
 
     .. change::
         :tags: mysql, bug
         :tickets: 2791
         :versions: 0.8.3, 0.9.0b1
 
-        Updates to MySQL reserved words for versions 5.5, 5.6, courtesy
-        Hanno Schlichting.
+      Updates to MySQL reserved words for versions 5.5, 5.6, courtesy
+      Hanno Schlichting.
 
     .. change::
         :tags: sql, bug, cte
         :tickets: 2783
         :versions: 0.8.3, 0.9.0b1
 
-        Fixed bug in common table expression system where if the CTE were
-        used only as an ``alias()`` construct, it would not render using the
-        WITH keyword.
+      Fixed bug in common table expression system where if the CTE were
+      used only as an ``alias()`` construct, it would not render using the
+      WITH keyword.
 
     .. change::
         :tags: bug, sql
         :tickets: 2784
         :versions: 0.8.3, 0.9.0b1
 
-        Fixed bug in :class:`.CheckConstraint` DDL where the "quote" flag from a
-        :class:`.Column` object would not be propagated.
+      Fixed bug in :class:`.CheckConstraint` DDL where the "quote" flag from a
+      :class:`.Column` object would not be propagated.
 
     .. change::
         :tags: bug, orm
index b8d7094d08473608d82a8c1a71dfd8dd96e91b0d..26f2fecf9c3b2c7da003405f13810d16064a8ae8 100644 (file)
@@ -1,4 +1,3 @@
-
 =============
 0.8 Changelog
 =============
index 2e418abd01628a583cb08f60891450cd9cc369e5..52b9a3deef9979609a90d3bc8cbb2d8502d0ad59 100644 (file)
@@ -7,9 +7,11 @@
     .. include:: changelog_08.rst
         :start-line: 5
 
+
     .. include:: changelog_07.rst
         :start-line: 5
 
+
 .. _unreleased_changelog::
     :version: 0.9.11
 
index 1ae1f32162a27df89fcc077129101d1e6c608bd7..c5945a32ced9cc70a13a338065283ba0e90828c2 100644 (file)
@@ -1,5 +1,3 @@
-
-
 =============
 1.0 Changelog
 =============
@@ -9,13 +7,16 @@
     .. include:: changelog_09.rst
         :start-line: 5
 
+
     .. include:: changelog_08.rst
         :start-line: 5
 
+
     .. include:: changelog_07.rst
         :start-line: 5
 
 
+
 .. changelog::
     :version: 1.0.19
     :released: August 3, 2017
index 9f3e73303b4679a492585a864904fa4ed4ad432e..e4d91b2e4060d6bb894b5797549620498cde951b 100644 (file)
@@ -7,16 +7,20 @@
     .. include:: changelog_10.rst
         :start-line: 5
 
+
     .. include:: changelog_09.rst
         :start-line: 5
 
+
     .. include:: changelog_08.rst
         :start-line: 5
 
+
     .. include:: changelog_07.rst
         :start-line: 5
 
 
+
 .. changelog::
     :version: 1.1.19
     :include_notes_from: unreleased_11
index 64ef46c263e85c321c39c66ed3a460575996074f..33cfbba4fc7d3160a42fcdd5834f36e9d1f4443f 100644 (file)
@@ -1296,7 +1296,7 @@ be no pending state change on an unloaded attribute.
 :ticket:`2320`
 
 :attr:`.Column.key` is honored in the :attr:`.Select.c` attribute of :func:`.select` with :meth:`.Select.apply_labels`
------------------------------------------------------------------------------------------------------------------------
+--------------------------------------------------------------------------------------------------------------------------------
 
 Users of the expression system know that :meth:`.Select.apply_labels`
 prepends the table name to each column name, affecting the
index 0415438a0eb6cebb01f2adf1642ac6375f9972fe..311b32df3c880d1f825dbf7ddb2aa0ea6af7a3b8 100644 (file)
@@ -1,7 +1,7 @@
 .. _metadata_constraints_toplevel:
 .. _metadata_constraints:
 
-.. module:: sqlalchemy.schema
+.. currentmodule:: sqlalchemy.schema
 
 ================================
 Defining Constraints and Indexes
index 1120f04bfe2f0e9e0c155c71a61950dfe96665e3..bf6fdbabbc6461b5a977013220de4be04e8ce873 100644 (file)
@@ -1,4 +1,4 @@
-.. module:: sqlalchemy.types
+.. currentmodule:: sqlalchemy.types
 
 .. _types_custom:
 
index db0905d72620e147a861baed7870ce69a287ff06..38a660982cc60596a9703b96bb49b1784fa8cdcf 100644 (file)
@@ -1,6 +1,6 @@
 .. _metadata_ddl_toplevel:
 .. _metadata_ddl:
-.. module:: sqlalchemy.schema
+.. currentmodule:: sqlalchemy.schema
 
 Customizing DDL
 ===============
index cbfe27c33d58f26f25943e9567e9fbe8e7c61cc1..6372e5e547ca8266bdcd9bf617f1dee8c23ec7b4 100644 (file)
@@ -1,4 +1,4 @@
-.. module:: sqlalchemy.schema
+.. currentmodule:: sqlalchemy.schema
 
 .. _metadata_defaults_toplevel:
 
index 3b6949b79580aee8fd7846dff02742fbf90791a7..51c9a2f1cd51d90d39ddbf9503065d383cb230d0 100644 (file)
@@ -5,7 +5,7 @@ INSERT, UPDATE and DELETE statements build on a hierarchy starting
 with :class:`.UpdateBase`.   The :class:`.Insert` and :class:`.Update`
 constructs build on the intermediary :class:`.ValuesBase`.
 
-.. module:: sqlalchemy.sql.expression
+.. currentmodule:: sqlalchemy.sql.expression
 
 .. autofunction:: delete
 
index 90164850d4cb8a60915a75dae413fa3f4bfdf881..cb53eda13988f4466df81554dafa2a7922705f14 100644 (file)
@@ -5,7 +5,7 @@
 SQL and Generic Functions
 =========================
 
-.. module:: sqlalchemy.sql.expression
+.. currentmodule:: sqlalchemy.sql.expression
 
 SQL functions which are known to SQLAlchemy with regards to database-specific
 rendering, return types and argument behavior. Generic functions are invoked
index 55962ebe5a3ec8094b7f4b2486226bd6f908649b..fecca8e30e5dbf9425320fdd15d0f64aa481454d 100644 (file)
@@ -1,4 +1,4 @@
-.. module:: sqlalchemy.schema
+.. currentmodule:: sqlalchemy.schema
 
 .. _metadata_reflection_toplevel:
 .. _metadata_reflection:
index 8553ebcbf67831c5fa0eb8af633d2c17a3285e61..5de685c7f24840f04ed368e14724595f8929fd96 100644 (file)
@@ -4,7 +4,7 @@
 Schema Definition Language
 ==========================
 
-.. module:: sqlalchemy.schema
+.. currentmodule:: sqlalchemy.schema
 
 This section references SQLAlchemy **schema metadata**, a comprehensive system of describing and inspecting
 database schemas.
index 57e389722e1f595184a7842ccddefc31e0c30007..8952daec5e6fdbb2ae7e22bddba4d31fc415efbe 100644 (file)
@@ -7,7 +7,7 @@ distinguishing feature is their :attr:`.FromClause.c` attribute, which is
 a namespace of all the columns contained within the FROM clause (these
 elements are themselves :class:`.ColumnElement` subclasses).
 
-.. module:: sqlalchemy.sql.expression
+.. currentmodule:: sqlalchemy.sql.expression
 
 .. autofunction:: alias
 
index bdd2091f61661439bda480fea84ebd99792da8f9..daf2ada2f62ed787b4f42081c8c7694431b3ffec 100644 (file)
@@ -1,7 +1,7 @@
 Column Elements and Expressions
 ===============================
 
-.. module:: sqlalchemy.sql.expression
+.. currentmodule:: sqlalchemy.sql.expression
 
 The expression API consists of a series of classes each of which represents a
 specific lexical element within a SQL string.  Composed together
index f165df5a2668259c0075b269d9f2131dc215b764..115cbd202f210469dbfc49ce7c739f7c797dd1e8 100644 (file)
@@ -1,4 +1,4 @@
-.. module:: sqlalchemy.types
+.. currentmodule:: sqlalchemy.types
 
 .. _types_api:
 
index abd969933660275c913c542293dfc03c396c4bcc..10a6f10e56acec1f23007eda6f914613dba174ec 100644 (file)
@@ -13,7 +13,6 @@ This section presents additional information about collection configuration
 and techniques.
 
 .. _largecollections:
-.. currentmodule:: sqlalchemy.orm
 
 Working with Large Collections
 ==============================
@@ -185,6 +184,7 @@ database.
     :paramref:`.orm.mapper.passive_deletes` - similar feature on :func:`.mapper`
 
 .. currentmodule:: sqlalchemy.orm.collections
+
 .. _custom_collections:
 
 Customizing Collection Access
index 5cd86d99aa6825838f6c24978946b8f05497ad34..6b9d857d63fcb604fb2aaf448bd769e5530338e5 100644 (file)
@@ -1,4 +1,4 @@
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
 
 .. _mapper_composite:
 
index 4d7268557d39c15ed3a74498202e04880ab8ac8f..ded70a9720c5a6b67385a5c3d9ca92d3641ce6e0 100644 (file)
@@ -1,4 +1,4 @@
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
 
 .. _mapping_constructors:
 
index afa54078f1464337c9429685d0f2f6f6b06f9418..693f40e047d09bb141d7fda489617bf076963f19 100644 (file)
@@ -1,4 +1,4 @@
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
 
 ===============
 Loading Columns
index bce40bfb4910b86216f90f052e5604a31d140951..535c075c94b65545baff04eed32e4f63ef1deb23 100644 (file)
@@ -1,4 +1,4 @@
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
 
 Changing Attribute Behavior
 ===========================
index b17798d0b5a15fc423eac88838fa022f0378efd9..09625f51f134f66cd87fed1ad4e3dc3701439593 100644 (file)
@@ -1,4 +1,4 @@
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
 
 .. _mapper_sql_expressions:
 
index cd7c379cd2ee5c849efc279c32bae5bc10c908f8..99e0ba52d441adf00fb379c5c91c3b2d99fd5155 100644 (file)
@@ -1,4 +1,4 @@
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
 
 Class Mapping API
 =================
index 7d7b691409145cf2fa3047e95d7e7f030df31ae6..71e145747c12c8d7a7854ee6c230335237960918 100644 (file)
@@ -1,4 +1,4 @@
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
 
 Mapping Table Columns
 =====================
index a192bad941436e5a7778ffa62083b03ec5830698..e997a4dcbde2013ffbfcafee63bf8a5ed5cc4b6c 100644 (file)
@@ -1,4 +1,4 @@
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
 
 .. _query_api_toplevel:
 
index 03045f6980d75d41f26d07d9ddcdc616a73ef85c..2766c4020a714a654f578653c1b9568b2b85c61d 100644 (file)
@@ -1,4 +1,4 @@
-.. automodule:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
 
 Relationships API
 -----------------
index f5cbac87eba4342eb3ea61a6fdd1f53970295ef8..37f59d34523473b02253423728ccdfd0260ee98e 100644 (file)
@@ -1,4 +1,4 @@
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
 
 .. _relationship_config_toplevel:
 
index 65efd5dbd9f1f01b0c47ac68ee55f673e0b6ff04..e8829af49a61166f04cd6101fdc3f1437c928c5b 100644 (file)
@@ -1,4 +1,4 @@
-.. module:: sqlalchemy.orm
+.. currentmodule:: sqlalchemy.orm
 
 ===============================
 Mapping Columns and Expressions
index 8b1ba660ff1ac8e832d8e9f126d59f362b3805d6..041ebc0a135cef038916ef454be9ad667d81bf62 100644 (file)
@@ -1,4 +1,4 @@
-.. module:: sqlalchemy.orm.session
+.. currentmodule:: sqlalchemy.orm.session
 
 Session API
 ===========
index a6a85c60fee557b6cf1af4096468453791e6f0e3..7de1b9807ed3e28f456e6d9913871e7bac5eb09a 100644 (file)
@@ -375,7 +375,9 @@ class Executable(Generative):
         self._execution_options = self._execution_options.union(kw)
 
     def execute(self, *multiparams, **params):
-        """Compile and execute this :class:`.Executable`."""
+        """Compile and execute this :class:`.Executable`.
+
+        """
         e = self.bind
         if e is None:
             label = getattr(self, 'description', self.__class__.__name__)