Skip to content

Commit 5e88e6e

Browse files
zzzeekzzzeek
committed
fix most sphinx warnings (1.4)
still can't figure out the warnings with some of the older changelog files. this cherry-picks the sphinx fixes from 1.4 and additionally fixes a small number of new issues in the 2.0 docs. However, 2.0 has many more errors to fix, primarily from the removal of the legacy tutorials left behind a lot of labels that need to be re-linked to the new tutorial. Fixes: #7946 Change-Id: Id657ab23008eed0b133fed65b2f9ea75a626215c (cherry picked from commit 9b55a42)
1 parent 625020c commit 5e88e6e

36 files changed

+134
-85
lines changed

‎doc/build/changelog/changelog_06.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
0.6 Changelog
33
=============
44

5+
56
.. changelog::
67
:version: 0.6.9
78
:released: Sat May 05 2012

‎doc/build/changelog/changelog_08.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
.. include:: changelog_07.rst
88
:start-line: 5
99

10+
1011
.. changelog::
1112
:version: 0.8.7
1213
:released: July 22, 2014

‎doc/build/changelog/changelog_09.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1920,7 +1920,7 @@
19201920
.. change::
19211921
:tags: feature, sql
19221922

1923-
Added :paramref:`.MetaData.reflect.**dialect_kwargs`
1923+
Added :paramref:`.MetaData.reflect.dialect_kwargs`
19241924
to support dialect-level reflection options for all :class:`_schema.Table`
19251925
objects reflected.
19261926

‎doc/build/changelog/changelog_11.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,6 @@
2020
:start-line: 5
2121

2222

23-
2423
.. changelog::
2524
:version: 1.1.18
2625
:released: March 6, 2018
@@ -1076,7 +1075,7 @@
10761075
:tickets: 3842
10771076

10781077
Fixed bug where newly added warning for primary key on insert w/o
1079-
autoincrement setting (see :ref:`change_3216`) would fail to emit
1078+
autoincrement setting (see :ticket:`3216`) would fail to emit
10801079
correctly when invoked upon a lower-case :func:`.table` construct.
10811080

10821081
.. change:: 3852

‎doc/build/changelog/changelog_12.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@
453453
:tickets: 4352
454454

455455
The column conflict resolution technique discussed at
456-
:ref:`declarative_column_conflicts` is now functional for a :class:`_schema.Column`
456+
:ref:`orm_inheritance_column_conflicts` is now functional for a :class:`_schema.Column`
457457
that is also a primary key column. Previously, a check for primary key
458458
columns declared on a single-inheritance subclass would occur before the
459459
column copy were allowed to pass.

‎doc/build/changelog/changelog_13.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -950,8 +950,8 @@
950950
:tags: usecase, postgresql
951951
:tickets: 5265
952952

953-
Added support for columns or type :class:`.ARRAY` of :class:`.Enum`,
954-
:class:`.JSON` or :class:`_postgresql.JSONB` in PostgreSQL.
953+
Added support for columns or type :class:`_sqltypes.ARRAY` of :class:`.Enum`,
954+
:class:`_postgresql.JSON` or :class:`_postgresql.JSONB` in PostgreSQL.
955955
Previously a workaround was required in these use cases.
956956

957957

@@ -1002,7 +1002,7 @@
10021002
:tickets: 5266
10031003

10041004
Raise an explicit :class:`.exc.CompileError` when adding a table with a
1005-
column of type :class:`.ARRAY` of :class:`.Enum` configured with
1005+
column of type :class:`_sqltypes.ARRAY` of :class:`.Enum` configured with
10061006
:paramref:`.Enum.native_enum` set to ``False`` when
10071007
:paramref:`.Enum.create_constraint` is not set to ``False``
10081008

@@ -1966,13 +1966,13 @@
19661966

19671967
:class:`_types.JSON`
19681968

1969-
:meth:`.JSON.Comparator.as_string`
1969+
:meth:`_sqltypes.JSON.Comparator.as_string`
19701970

1971-
:meth:`.JSON.Comparator.as_boolean`
1971+
:meth:`_sqltypes.JSON.Comparator.as_boolean`
19721972

1973-
:meth:`.JSON.Comparator.as_float`
1973+
:meth:`_sqltypes.JSON.Comparator.as_float`
19741974

1975-
:meth:`.JSON.Comparator.as_integer`
1975+
:meth:`_sqltypes.JSON.Comparator.as_integer`
19761976

19771977
.. change::
19781978
:tags: usecase, oracle
@@ -3828,7 +3828,7 @@
38283828
Added support for the parameters in an ON DUPLICATE KEY UPDATE statement on
38293829
MySQL to be ordered, since parameter order in a MySQL UPDATE clause is
38303830
significant, in a similar manner as that described at
3831-
:ref:`updates_order_parameters`. Pull request courtesy Maxim Bublis.
3831+
:ref:`tutorial_parameter_ordered_updates`. Pull request courtesy Maxim Bublis.
38323832

38333833
.. seealso::
38343834

‎doc/build/changelog/changelog_14.rst‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This document details individual issue-level changes made throughout
3434
:tickets: 7936
3535

3636
Fixed regression where the change made for :ticket:`7861`, released in
37-
version 1.4.33, that brought the :class:`.Insert` construct to be partially
37+
version 1.4.33, that brought the :class:`_sql.Insert` construct to be partially
3838
recognized as an ORM-enabled statement did not properly transfer the
3939
correct mapper / mapped table state to the :class:`.Session`, causing the
4040
:meth:`.Session.get_bind` method to fail for a :class:`.Session` that was
@@ -58,7 +58,7 @@ This document details individual issue-level changes made throughout
5858
:tags: bug, postgresql
5959
:tickets: 6515
6060

61-
Fixed bug in :class:`.ARRAY` datatype in combination with :class:`.Enum` on
61+
Fixed bug in :class:`_sqltypes.ARRAY` datatype in combination with :class:`.Enum` on
6262
PostgreSQL where using the ``.any()`` or ``.all()`` methods to render SQL
6363
ANY() or ALL(), given members of the Python enumeration as arguments, would
6464
produce a type adaptation failure on all drivers.
@@ -87,7 +87,7 @@ This document details individual issue-level changes made throughout
8787
:tickets: 7930
8888

8989
Fixed an issue in the psycopg2 dialect when using the
90-
:paramref:`.create_engine.pool_pre_ping` parameter which would cause
90+
:paramref:`_sa.create_engine.pool_pre_ping` parameter which would cause
9191
user-configured ``AUTOCOMMIT`` isolation level to be inadvertently reset by
9292
the "ping" handler.
9393

@@ -105,15 +105,15 @@ This document details individual issue-level changes made throughout
105105
:tags: bug, engine
106106
:tickets: 7953
107107

108-
Added a warning regarding a bug which exists in the :meth:`.Result.columns`
109-
method when passing 0 for the index in conjunction with a :class:`.Result`
108+
Added a warning regarding a bug which exists in the :meth:`_result.Result.columns`
109+
method when passing 0 for the index in conjunction with a :class:`_result.Result`
110110
that will return a single ORM entity, which indicates that the current
111-
behavior of :meth:`.Result.columns` is broken in this case as the
112-
:class:`.Result` object will yield scalar values and not :class:`.Row`
111+
behavior of :meth:`_result.Result.columns` is broken in this case as the
112+
:class:`_result.Result` object will yield scalar values and not :class:`.Row`
113113
objects. The issue will be fixed in 2.0, which would be a
114114
backwards-incompatible change for code that relies on the current broken
115115
behavior. Code which wants to receive a collection of scalar values should
116-
use the :meth:`.Result.scalars` method, which will return a new
116+
use the :meth:`_result.Result.scalars` method, which will return a new
117117
:class:`.ScalarResult` object that yields non-row scalar objects.
118118

119119

@@ -199,7 +199,7 @@ This document details individual issue-level changes made throughout
199199
:tickets: 7878
200200

201201
Fixed regression caused by :ticket:`7861` where invoking an
202-
:class:`.Insert` construct which contained ORM entities directly via
202+
:class:`_sql.Insert` construct which contained ORM entities directly via
203203
:meth:`_orm.Session.execute` would fail.
204204

205205
.. change::
@@ -226,8 +226,8 @@ This document details individual issue-level changes made throughout
226226
and COMMIT log messages do not actually indicate a real transaction when
227227
the AUTOCOMMIT isolation level is in use; messaging has been extended to
228228
include the BEGIN message itself, and the messaging has also been fixed to
229-
accommodate when the :class:`.Engine` level
230-
:paramref:`.create_engine.isolation_level` parameter was used directly.
229+
accommodate when the :class:`_engine.Engine` level
230+
:paramref:`_sa.create_engine.isolation_level` parameter was used directly.
231231

232232
.. change::
233233
:tags: bug, mssql, regression
@@ -314,7 +314,7 @@ This document details individual issue-level changes made throughout
314314
:tags: usecase, engine
315315
:tickets: 7877, 7815
316316

317-
Added new parameter :paramref:`.Engine.dispose.close`, defaulting to True.
317+
Added new parameter :paramref:`_engine.Engine.dispose.close`, defaulting to True.
318318
When False, the engine disposal does not touch the connections in the old
319319
pool at all, simply dropping the pool and replacing it. This use case is so
320320
that when the original pool is transferred from a parent process, the
@@ -339,7 +339,7 @@ This document details individual issue-level changes made throughout
339339

340340
Added new attributes :attr:`.UpdateBase.returning_column_descriptions` and
341341
:attr:`.UpdateBase.entity_description` to allow for inspection of ORM
342-
attributes and entities that are installed as part of an :class:`.Insert`,
342+
attributes and entities that are installed as part of an :class:`_sql.Insert`,
343343
:class:`.Update`, or :class:`.Delete` construct. The
344344
:attr:`.Select.column_descriptions` accessor is also now implemented for
345345
Core-only selectables.
@@ -1638,15 +1638,15 @@ This document details individual issue-level changes made throughout
16381638
:tags: bug, orm
16391639
:tickets: 7128
16401640

1641-
Fixed bug where iterating a :class:`.Result` from a :class:`_orm.Session`
1641+
Fixed bug where iterating a :class:`_result.Result` from a :class:`_orm.Session`
16421642
after that :class:`_orm.Session` were closed would partially attach objects
16431643
to that session in an essentially invalid state. It now raises an exception
16441644
with a link to new documentation if an **un-buffered** result is iterated
16451645
from a :class:`_orm.Session` that was closed or otherwise had the
1646-
:meth:`_orm.Session.expunge_all` method called after that :class:`.Result`
1646+
:meth:`_orm.Session.expunge_all` method called after that :class:`_result.Result`
16471647
was generated. The ``prebuffer_rows`` execution option, as is used
16481648
automatically by the asyncio extension for client-side result sets, may be
1649-
used to produce a :class:`.Result` where the ORM objects are prebuffered,
1649+
used to produce a :class:`_result.Result` where the ORM objects are prebuffered,
16501650
and in this case iterating the result will produce a series of detached
16511651
objects.
16521652

@@ -3484,7 +3484,7 @@ This document details individual issue-level changes made throughout
34843484
:tickets: 6361
34853485

34863486
Fixed issue where usage of an explicit :class:`.Sequence` would produce
3487-
inconsistent "inline" behavior for an :class:`.Insert` construct that
3487+
inconsistent "inline" behavior for an :class:`_sql.Insert` construct that
34883488
includes multiple values phrases; the first seq would be inline but
34893489
subsequent ones would be "pre-execute", leading to inconsistent sequence
34903490
ordering. The sequence expressions are now fully inline.
@@ -4931,7 +4931,7 @@ This document details individual issue-level changes made throughout
49314931
:tags: bug, engine, sqlite
49324932
:tickets: 5845
49334933

4934-
Fixed bug in the 2.0 "future" version of :class:`.Engine` where emitting
4934+
Fixed bug in the 2.0 "future" version of :class:`_engine.Engine` where emitting
49354935
SQL during the :meth:`.EngineEvents.begin` event hook would cause a
49364936
re-entrant (recursive) condition due to autobegin, affecting among other
49374937
things the recipe documented for SQLite to allow for savepoints and

‎doc/build/conf.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@
109109

110110
changelog_render_changeset = "https://www.sqlalchemy.org/trac/changeset/%s"
111111

112-
exclude_patterns = ["build", "**/unreleased*/*", "*_include.rst"]
112+
exclude_patterns = ["build", "**/unreleased*/*", "**/*_include.rst"]
113113

114114
autodoc_class_signature = "separated"
115115
autodoc_typehints_format = "short"

‎doc/build/core/connections.rst‎

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1981,11 +1981,12 @@ Connection / Engine API
19811981
Result Set API
19821982
=================
19831983

1984-
.. autoclass:: BaseCursorResult
1984+
.. autoclass:: ChunkedIteratorResult
19851985
:members:
19861986

1987-
.. autoclass:: ChunkedIteratorResult
1987+
.. autoclass:: CursorResult
19881988
:members:
1989+
:inherited-members:
19891990

19901991
.. autoclass:: FrozenResult
19911992
:members:
@@ -1999,22 +2000,14 @@ Result Set API
19992000
.. autoclass:: Result
20002001
:members:
20012002
:inherited-members:
2002-
:exclude-members: memoized_attribute, memoized_instancemethod
20032003

20042004
.. autoclass:: ScalarResult
20052005
:members:
20062006
:inherited-members:
2007-
:exclude-members: memoized_attribute, memoized_instancemethod
20082007

20092008
.. autoclass:: MappingResult
20102009
:members:
20112010
:inherited-members:
2012-
:exclude-members: memoized_attribute, memoized_instancemethod
2013-
2014-
.. autoclass:: CursorResult
2015-
:members:
2016-
:inherited-members:
2017-
:exclude-members: memoized_attribute, memoized_instancemethod
20182011

20192012
.. autoclass:: Row
20202013
:members:

‎doc/build/core/constraints.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -768,6 +768,7 @@ The above schema will produce::
768768

769769
Constraints API
770770
---------------
771+
771772
.. autoclass:: Constraint
772773
:members:
773774
:inherited-members:

0 commit comments

Comments
 (0)