Commits

Andrew Godwin  committed b836b0f

Slow start to a big docs push.

  • Participants
  • Parent commits 09e5d62

Comments (0)

Files changed (3)

 South.egg-info/*
 # Ignore test log
 south/tests/test.log
+
+# Also ignore Sphinx files
+syntax: regexp
+^docs/\_build/

File docs/databaseapi.rst

+Database API
+============
+
+South ships with a full database-agnostic API for performing schema changes
+on databases, much like Django's ORM provides data manipulation support.
+
+Currently, South supports:
+
+ - PostgreSQL
+ - MySQL
+ - SQLite
+ - Microsoft SQL Server (beta support)
+ - Oracle (alpha support)
+ 
+Methods
+-------
+
+These are how you perform changes on the database. See "Accessing The API" below
+to see where these run.
+
+
+Accessing The API
+-----------------
+
+South automatically exposes the correct set of database API operations as
+``south.db.db``; it detects which database backend you're using from your
+Django settings file.
+
+If you're using multiple database support (Django 1.2 and higher),
+there's a corresponding ``south.db.dbs`` dictionary
+which contains a DatabaseOperations object (the object which has the methods
+defined above) for each database alias in your configuration file.

File docs/index.rst

-.. South documentation master file, created by
-   sphinx-quickstart on Mon Feb 15 23:32:07 2010.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+South documentation
+===================
 
-Welcome to South's documentation!
-=================================
+South is a tool to provide consistent, easy-to-use and database-agnostic
+migrations for Django applications.
 
-Contents:
+This is the documentation for the current version (0.7); previous versions'
+documentation was written directly into our wiki, but is a subset of what is
+written here. Any new features are marked as such.
+
+Contents
+--------
 
 .. toctree::
    :maxdepth: 2
+   
+   databaseapi
 
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-