diff options
| author | Mike Bayer <mike_mp@zzzcomputing.com> | 2011-11-11 11:38:33 -0800 |
|---|---|---|
| committer | Mike Bayer <mike_mp@zzzcomputing.com> | 2011-11-11 11:38:33 -0800 |
| commit | 57df5838feaf11ee4168a6e26ca6f3a128eccde6 (patch) | |
| tree | ed8315d84af4e4dcb656e520c9625787622b17ed /docs/build/api.rst | |
| parent | 8ec2291703383e93fba781a6c141eccaaefb10c1 (diff) | |
| download | alembic-57df5838feaf11ee4168a6e26ca6f3a128eccde6.tar.gz | |
some docs
Diffstat (limited to 'docs/build/api.rst')
| -rw-r--r-- | docs/build/api.rst | 21 |
1 files changed, 19 insertions, 2 deletions
diff --git a/docs/build/api.rst b/docs/build/api.rst index 4747ae6..ef44234 100644 --- a/docs/build/api.rst +++ b/docs/build/api.rst @@ -18,14 +18,27 @@ env.py Directives Internals ========= -.. automodule:: alembic.config +.. currentmodule:: alembic.command + +Commands +-------- + +Alembic commands are all represented by functions in the :mod:`alembic.command` +package. They all accept the same style of usage, being sent +the :class:`~.alembic.config.Config` object as the first argument. + + +.. automodule:: alembic.command :members: :undoc-members: -.. automodule:: alembic.command +Misc +---- +.. automodule:: alembic.config :members: :undoc-members: + .. automodule:: alembic.script :members: :undoc-members: @@ -47,6 +60,7 @@ MySQL .. automodule:: alembic.ddl.mysql :members: :undoc-members: + :show-inheritance: MS-SQL ^^^^^^ @@ -54,6 +68,7 @@ MS-SQL .. automodule:: alembic.ddl.mssql :members: :undoc-members: + :show-inheritance: Postgresql ^^^^^^^^^^ @@ -61,6 +76,7 @@ Postgresql .. automodule:: alembic.ddl.postgresql :members: :undoc-members: + :show-inheritance: SQLite ^^^^^^ @@ -68,3 +84,4 @@ SQLite .. automodule:: alembic.ddl.sqlite :members: :undoc-members: + :show-inheritance: |