From fb0692ccd6d73d14d3a2cc300300b72e7251587b Mon Sep 17 00:00:00 2001 From: iElectric Date: Thu, 8 Jul 2010 19:03:44 +0200 Subject: [PATCH] add descriptions of modules in docs --- docs/api.rst | 72 ++++++++++++++++++++++++++-------------------------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 5d960e8..fb03040 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1,20 +1,20 @@ -Module :mod:`migrate.changeset` -=============================== +Module :mod:`migrate.changeset` -- Schema migration API +============================================================= .. automodule:: migrate.changeset :members: :synopsis: Database changeset management -Module :mod:`ansisql ` -------------------------------------------------- +Module :mod:`ansisql ` -- Standard SQL implementation +------------------------------------------------------------------------------------ .. automodule:: migrate.changeset.ansisql :members: :member-order: groupwise :synopsis: Standard SQL implementation for altering database schemas -Module :mod:`constraint ` -------------------------------------------------------- +Module :mod:`constraint ` -- Constraint schema migration API +--------------------------------------------------------------------------------------------- .. automodule:: migrate.changeset.constraint :members: @@ -22,8 +22,8 @@ Module :mod:`constraint ` :member-order: groupwise :synopsis: Standalone schema constraint objects -Module :mod:`databases ` ------------------------------------------------------ +Module :mod:`databases ` -- Database specific schema migration +----------------------------------------------------------------------------------------------- .. automodule:: migrate.changeset.databases :members: @@ -83,23 +83,23 @@ Module :mod:`visitor ` .. automodule:: migrate.changeset.databases.visitor :members: -Module :mod:`exceptions ` -------------------------------------------------------- +Module :mod:`exceptions ` -- Exception definitions +--------------------------------------------------------------------------------------- .. automodule:: migrate.changeset.exceptions :members: :synopsis: Changeset exception classes -Module :mod:`schema ` ------------------------------------------------ +Module :mod:`schema ` -- Additional API to SQLAlchemy for migrations +------------------------------------------------------------------------------------------------- .. automodule:: migrate.changeset.schema :members: :synopsis: Schema changeset handling functions -Module :mod:`migrate.versioning` -================================ +Module :mod:`migrate.versioning` -- Database versioning and repository management +================================================================================== .. automodule:: migrate.versioning :members: @@ -107,59 +107,59 @@ Module :mod:`migrate.versioning` .. _versioning-api: -Module :mod:`api ` ------------------------------------------- +Module :mod:`api ` -- Python API commands +-------------------------------------------------------------------------- .. automodule:: migrate.versioning.api :members: :synopsis: External API for :mod:`migrate.versioning` -Module :mod:`exceptions ` --------------------------------------------------------- +Module :mod:`exceptions ` -- Exception definitions +-------------------------------------------------------------------------------------- .. automodule:: migrate.versioning.exceptions :members: :synopsis: Exception classes for :mod:`migrate.versioning` -Module :mod:`genmodel ` ----------------------------------------------------- +Module :mod:`genmodel ` -- ORM Model generator +------------------------------------------------------------------------------------- .. automodule:: migrate.versioning.genmodel :members: :synopsis: Python database model generator and differencer -Module :mod:`pathed ` ------------------------------------------------- +Module :mod:`pathed ` -- Path utilities +---------------------------------------------------------------------------- .. automodule:: migrate.versioning.pathed :members: :synopsis: File/Directory handling class -Module :mod:`repository ` --------------------------------------------------------- +Module :mod:`repository ` -- Repository management +------------------------------------------------------------------------------------- .. automodule:: migrate.versioning.repository :members: :synopsis: SQLAlchemy migrate repository management :member-order: groupwise -Module :mod:`schema ` ------------------------------------------------- +Module :mod:`schema ` -- Migration upgrade/downgrade +---------------------------------------------------------------------------------- .. automodule:: migrate.versioning.schema :members: :member-order: groupwise :synopsis: Database schema management -Module :mod:`schemadiff ` --------------------------------------------------------- +Module :mod:`schemadiff ` -- ORM Model differencing +------------------------------------------------------------------------------------- .. automodule:: migrate.versioning.schemadiff :members: :synopsis: Database schema and model differencing -Module :mod:`script ` ------------------------------------------------- +Module :mod:`script ` -- Script actions +-------------------------------------------------------------------- .. automodule:: migrate.versioning.script.base :synopsis: Script utilities @@ -178,22 +178,22 @@ Module :mod:`script ` :show-inheritance: :inherited-members: -Module :mod:`shell ` ----------------------------------------------- +Module :mod:`shell ` -- CLI interface +------------------------------------------------------------------ .. automodule:: migrate.versioning.shell :members: :synopsis: Shell commands -Module :mod:`util ` --------------------------------------------- +Module :mod:`util ` -- Various utility functions +-------------------------------------------------------------------------- .. automodule:: migrate.versioning.util :members: :synopsis: Utility functions -Module :mod:`version ` --------------------------------------------------- +Module :mod:`version ` -- Versioning management +----------------------------------------------------------------------------- .. automodule:: migrate.versioning.version :members: