diff options
Diffstat (limited to 'docs/build/api/commands.rst')
| -rw-r--r-- | docs/build/api/commands.rst | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/docs/build/api/commands.rst b/docs/build/api/commands.rst index 3d73ce5..65dcc09 100644 --- a/docs/build/api/commands.rst +++ b/docs/build/api/commands.rst @@ -1,10 +1,12 @@ +.. _alembic.command.toplevel: + ========= Commands ========= -Alembic commands are all represented by functions in the :mod:`alembic.command` +Alembic commands are all represented by functions in the :ref:`alembic.command.toplevel` package. They all accept the same style of usage, being sent -the :class:`~.alembic.config.Config` object as the first argument. +the :class:`.Config` object as the first argument. Commands can be run programmatically, by first constructing a :class:`.Config` object, as in:: @@ -32,7 +34,5 @@ information, rather than just running one of the built-in commands, use the :class:`.ScriptDirectory` and :class:`.MigrationContext` classes directly. -.. currentmodule:: alembic.command - .. automodule:: alembic.command :members: |