From 66c22bcae7e7ae7810d42fbf3ce7a7e102ffbabc Mon Sep 17 00:00:00 2001
From: "jan.dittberner" <unknown>
Date: Sun, 25 Jan 2009 12:50:40 +0000
Subject: [PATCH] first sphinx docstrings

---
 migrate/__init__.py            | 14 ++++++++++++++
 migrate/changeset/__init__.py  | 20 ++++++++++++++++++++
 migrate/changeset/ansisql.py   |  6 +++++-
 migrate/versioning/__init__.py |  7 +++++++
 4 files changed, 46 insertions(+), 1 deletion(-)

diff --git a/migrate/__init__.py b/migrate/__init__.py
index e69de29..fec12ba 100644
--- a/migrate/__init__.py
+++ b/migrate/__init__.py
@@ -0,0 +1,14 @@
+"""
+SQLAlchemy Migrate
+------------------
+
+SQLAlchemy migrate provides two APIs :mod:`migrate.versioning` for database
+schema version and repository management and :mod:`migrate.changeset` that
+allows to define database schema changes using Python.
+
+.. automodule:: migrate.changeset
+   :members:
+
+.. automodule:: migrate.versioning
+   :members:
+"""
diff --git a/migrate/changeset/__init__.py b/migrate/changeset/__init__.py
index b03ba1f..1cd3254 100644
--- a/migrate/changeset/__init__.py
+++ b/migrate/changeset/__init__.py
@@ -1,3 +1,23 @@
+"""
+Module :mod:`migrate.changeset`
+===============================
+
+This module extends SQLAlchemy and provides additional DDL [#]_ support.
+
+.. [#] SQL Data Definition Language
+
+.. automodule:: migrate.changeset.ansisql
+   :members:
+.. automodule:: migrate.changeset.constraint
+   :members:
+.. automodule:: migrate.changeset.databases
+   :synopsis: database specific changeset code
+   :members:
+.. automodule:: migrate.changeset.exceptions
+   :members:
+.. automodule:: migrate.changeset.schema
+   :members:
+"""
 from migrate.changeset.schema import *
 from migrate.changeset.constraint import *
 
diff --git a/migrate/changeset/ansisql.py b/migrate/changeset/ansisql.py
index 4c721e8..bacbbbc 100644
--- a/migrate/changeset/ansisql.py
+++ b/migrate/changeset/ansisql.py
@@ -1,4 +1,8 @@
-"""Extensions to SQLAlchemy for altering existing tables.
+"""
+Module :mod:`migrate.changeset.ansisql`
+---------------------------------------
+
+Extensions to SQLAlchemy for altering existing tables.
 At the moment, this isn't so much based off of ANSI as much as things that just
 happen to work with multiple databases.
 """
diff --git a/migrate/versioning/__init__.py b/migrate/versioning/__init__.py
index e69de29..810ee92 100644
--- a/migrate/versioning/__init__.py
+++ b/migrate/versioning/__init__.py
@@ -0,0 +1,7 @@
+"""
+Module migrate.versioning
+-------------------------
+
+This package provides functionality to create and manage repositories of
+database schema changesets and to apply these changesets to databases.
+"""