From 3b71acca23bea8a967349ee91829b282bf8bf66e Mon Sep 17 00:00:00 2001 From: Mike Bayer Date: Thu, 6 Jul 2017 11:59:04 -0400 Subject: [PATCH] - fix some sphinx link stuff --- alembic/command.py | 4 ++-- docs/build/api/operations.rst | 3 +-- docs/build/changelog.rst | 3 ++- docs/build/ops.rst | 7 +++++-- 4 files changed, 10 insertions(+), 7 deletions(-) diff --git a/alembic/command.py b/alembic/command.py index 694ee3f5..02805281 100644 --- a/alembic/command.py +++ b/alembic/command.py @@ -226,7 +226,7 @@ def upgrade(config, revision, sql=False, tag=None): :param sql: if True, use ``--sql`` mode :param tag: an arbitrary "tag" that can be intercepted by custom - ``env.py`` scripts via the :class:`.EnvironmentContext.get_tag_argument` + ``env.py`` scripts via the :meth:`.EnvironmentContext.get_tag_argument` method. """ @@ -264,7 +264,7 @@ def downgrade(config, revision, sql=False, tag=None): :param sql: if True, use ``--sql`` mode :param tag: an arbitrary "tag" that can be intercepted by custom - ``env.py`` scripts via the :class:`.EnvironmentContext.get_tag_argument` + ``env.py`` scripts via the :meth:`.EnvironmentContext.get_tag_argument` method. """ diff --git a/docs/build/api/operations.rst b/docs/build/api/operations.rst index e55b958b..e23dc20d 100644 --- a/docs/build/api/operations.rst +++ b/docs/build/api/operations.rst @@ -149,6 +149,7 @@ within the module level of the ``env.py`` script is sufficient. .. _operation_objects: +.. _alembic.operations.ops.toplevel: Built-in Operation Objects ============================== @@ -169,7 +170,5 @@ autogenerate system renders new migration scripts. The built-in operation objects are listed below. -.. _alembic.operations.ops.toplevel: - .. automodule:: alembic.operations.ops :members: diff --git a/docs/build/changelog.rst b/docs/build/changelog.rst index c85662c5..919a5063 100644 --- a/docs/build/changelog.rst +++ b/docs/build/changelog.rst @@ -10,7 +10,8 @@ Changelog .. change:: :tags: feature, runtime - Added a new callback hook :paramref:`.EnvironmentContext.on_version_apply`, + Added a new callback hook + :paramref:`.EnvironmentContext.configure.on_version_apply`, which allows user-defined code to be invoked each time an individual upgrade, downgrade, or stamp operation proceeds against a database. Pull request courtesy John Passaro. diff --git a/docs/build/ops.rst b/docs/build/ops.rst index 49aaef5c..6d12d922 100644 --- a/docs/build/ops.rst +++ b/docs/build/ops.rst @@ -39,5 +39,8 @@ circumstances they are called from an actual migration script, which itself would be invoked by the :meth:`.EnvironmentContext.run_migrations` method. -.. automodule:: alembic.operations - :members: Operations, BatchOperations +.. module:: alembic.operations + +.. autoclass:: Operations + +.. autoclass:: BatchOperations -- 2.47.2