x/sqlalchemy-migrate
Code Issues Proposed changes

add descriptions of modules in docs

Browse Source
This commit is contained in:
iElectric 2010-07-08 19:03:44 +02:00
parent 20e9e7c7c5
commit fb0692ccd6
1 changed files with 36 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
docs/api.rst
View File

@ -1,20 +1,20 @@
Module :mod:`migrate.changeset` Module :mod:`migrate.changeset` -- Schema migration API
=============================== =============================================================
.. automodule:: migrate.changeset .. automodule:: migrate.changeset
:members: :members:
:synopsis: Database changeset management :synopsis: Database changeset management
Module :mod:`ansisql <migrate.changeset.ansisql>` Module :mod:`ansisql <migrate.changeset.ansisql>` -- Standard SQL implementation
------------------------------------------------- ------------------------------------------------------------------------------------
.. automodule:: migrate.changeset.ansisql .. automodule:: migrate.changeset.ansisql
:members: :members:
:member-order: groupwise :member-order: groupwise
:synopsis: Standard SQL implementation for altering database schemas :synopsis: Standard SQL implementation for altering database schemas
Module :mod:`constraint <migrate.changeset.constraint>` Module :mod:`constraint <migrate.changeset.constraint>` -- Constraint schema migration API
------------------------------------------------------- ---------------------------------------------------------------------------------------------
.. automodule:: migrate.changeset.constraint .. automodule:: migrate.changeset.constraint
:members: :members:
@ -22,8 +22,8 @@ Module :mod:`constraint <migrate.changeset.constraint>`
:member-order: groupwise :member-order: groupwise
:synopsis: Standalone schema constraint objects :synopsis: Standalone schema constraint objects
Module :mod:`databases <migrate.changeset.databases>` Module :mod:`databases <migrate.changeset.databases>` -- Database specific schema migration
----------------------------------------------------- -----------------------------------------------------------------------------------------------
.. automodule:: migrate.changeset.databases .. automodule:: migrate.changeset.databases
:members: :members:
@ -83,23 +83,23 @@ Module :mod:`visitor <migrate.changeset.databases.visitor>`
.. automodule:: migrate.changeset.databases.visitor .. automodule:: migrate.changeset.databases.visitor
:members: :members:
Module :mod:`exceptions <migrate.changeset.exceptions>` Module :mod:`exceptions <migrate.changeset.exceptions>` -- Exception definitions
------------------------------------------------------- ---------------------------------------------------------------------------------------
.. automodule:: migrate.changeset.exceptions .. automodule:: migrate.changeset.exceptions
:members: :members:
:synopsis: Changeset exception classes :synopsis: Changeset exception classes
Module :mod:`schema <migrate.changeset.schema>` Module :mod:`schema <migrate.changeset.schema>` -- Additional API to SQLAlchemy for migrations
----------------------------------------------- -------------------------------------------------------------------------------------------------
.. automodule:: migrate.changeset.schema .. automodule:: migrate.changeset.schema
:members: :members:
:synopsis: Schema changeset handling functions :synopsis: Schema changeset handling functions
Module :mod:`migrate.versioning` Module :mod:`migrate.versioning` -- Database versioning and repository management
================================ ==================================================================================
.. automodule:: migrate.versioning .. automodule:: migrate.versioning
:members: :members:
@ -107,59 +107,59 @@ Module :mod:`migrate.versioning`
.. _versioning-api: .. _versioning-api:
Module :mod:`api <migrate.versioning.api>` Module :mod:`api <migrate.versioning.api>` -- Python API commands
------------------------------------------ --------------------------------------------------------------------------
.. automodule:: migrate.versioning.api .. automodule:: migrate.versioning.api
:members: :members:
:synopsis: External API for :mod:`migrate.versioning` :synopsis: External API for :mod:`migrate.versioning`
Module :mod:`exceptions <migrate.versioning.exceptions>` Module :mod:`exceptions <migrate.versioning.exceptions>` -- Exception definitions
-------------------------------------------------------- --------------------------------------------------------------------------------------
.. automodule:: migrate.versioning.exceptions .. automodule:: migrate.versioning.exceptions
:members: :members:
:synopsis: Exception classes for :mod:`migrate.versioning` :synopsis: Exception classes for :mod:`migrate.versioning`
Module :mod:`genmodel <migrate.versioning.genmodel>` Module :mod:`genmodel <migrate.versioning.genmodel>` -- ORM Model generator
---------------------------------------------------- -------------------------------------------------------------------------------------
.. automodule:: migrate.versioning.genmodel .. automodule:: migrate.versioning.genmodel
:members: :members:
:synopsis: Python database model generator and differencer :synopsis: Python database model generator and differencer
Module :mod:`pathed <migrate.versioning.pathed>` Module :mod:`pathed <migrate.versioning.pathed>` -- Path utilities
------------------------------------------------ ----------------------------------------------------------------------------
.. automodule:: migrate.versioning.pathed .. automodule:: migrate.versioning.pathed
:members: :members:
:synopsis: File/Directory handling class :synopsis: File/Directory handling class
Module :mod:`repository <migrate.versioning.repository>` Module :mod:`repository <migrate.versioning.repository>` -- Repository management
-------------------------------------------------------- -------------------------------------------------------------------------------------
.. automodule:: migrate.versioning.repository .. automodule:: migrate.versioning.repository
:members: :members:
:synopsis: SQLAlchemy migrate repository management :synopsis: SQLAlchemy migrate repository management
:member-order: groupwise :member-order: groupwise
Module :mod:`schema <migrate.versioning.schema>` Module :mod:`schema <migrate.versioning.schema>` -- Migration upgrade/downgrade
------------------------------------------------ ----------------------------------------------------------------------------------
.. automodule:: migrate.versioning.schema .. automodule:: migrate.versioning.schema
:members: :members:
:member-order: groupwise :member-order: groupwise
:synopsis: Database schema management :synopsis: Database schema management
Module :mod:`schemadiff <migrate.versioning.schemadiff>` Module :mod:`schemadiff <migrate.versioning.schemadiff>` -- ORM Model differencing
-------------------------------------------------------- -------------------------------------------------------------------------------------
.. automodule:: migrate.versioning.schemadiff .. automodule:: migrate.versioning.schemadiff
:members: :members:
:synopsis: Database schema and model differencing :synopsis: Database schema and model differencing
Module :mod:`script <migrate.versioning.script>` Module :mod:`script <migrate.versioning.script>` -- Script actions
------------------------------------------------ --------------------------------------------------------------------
.. automodule:: migrate.versioning.script.base .. automodule:: migrate.versioning.script.base
:synopsis: Script utilities :synopsis: Script utilities
@ -178,22 +178,22 @@ Module :mod:`script <migrate.versioning.script>`
:show-inheritance: :show-inheritance:
:inherited-members: :inherited-members:
Module :mod:`shell <migrate.versioning.shell>` Module :mod:`shell <migrate.versioning.shell>` -- CLI interface
---------------------------------------------- ------------------------------------------------------------------
.. automodule:: migrate.versioning.shell .. automodule:: migrate.versioning.shell
:members: :members:
:synopsis: Shell commands :synopsis: Shell commands
Module :mod:`util <migrate.versioning.util>` Module :mod:`util <migrate.versioning.util>` -- Various utility functions
-------------------------------------------- --------------------------------------------------------------------------
.. automodule:: migrate.versioning.util .. automodule:: migrate.versioning.util
:members: :members:
:synopsis: Utility functions :synopsis: Utility functions
Module :mod:`version <migrate.versioning.version>` Module :mod:`version <migrate.versioning.version>` -- Versioning management
-------------------------------------------------- -----------------------------------------------------------------------------
.. automodule:: migrate.versioning.version .. automodule:: migrate.versioning.version
:members: :members: