From d6a73b2c64391c01538467ac506848b697ccdbc1 Mon Sep 17 00:00:00 2001
From: James Tauber <jtauber@jtauber.com>
Date: Sun, 5 Feb 2012 23:06:16 -0500
Subject: [PATCH] added documentation for conference models

---
 symposion_project/docs/conference.rst | 40 +++++++++++++++++++++++++++
 symposion_project/docs/index.rst      |  5 ++--
 2 files changed, 43 insertions(+), 2 deletions(-)
 create mode 100644 symposion_project/docs/conference.rst

diff --git a/symposion_project/docs/conference.rst b/symposion_project/docs/conference.rst
new file mode 100644
index 00000000..213a626b
--- /dev/null
+++ b/symposion_project/docs/conference.rst
@@ -0,0 +1,40 @@
+Conference App
+==============
+
+The overall conference settings are managed via the ``conference`` app.
+
+Conferences and their sections are added and configured via the Django admin.
+
+
+Models
+------
+
+Each conference needs an instance of a ``Conference`` model. In most cases you
+will only need one of these but Symposion does support multiple conferences
+sharing a database. Similar to the Django Sites framework, the conference your
+project is for is selected by the ``CONFERENCE_ID`` setting which defaults to
+``1`` but can be changed to the pk of another conference if you have more than
+one.
+
+The conference model has an optional ``start_date`` and ``end_date``
+indicating when the conference will run. These are optional so you can begin
+to configure your conference even if you don't know the exact dates.
+
+The conference model also has a ``timezone`` field which you should set to the
+timezone your conference will be in.
+
+There is also a ``Section`` model. This is useful if your conference has
+different parts to it that run of different days with a different management,
+review or scheduling process. Example of distinct sections might be
+"Tutorials", "Talks", "Workshops", "Sprints", "Expo". Many aspects of
+Symposion can be configured on a per-section basis.
+
+Each section has an optional ``start_date`` and ``end_date`` similar to the
+overall conference.
+
+
+Helper Functions
+----------------
+
+A ``conference.models.current_conference()`` function exists to retrieve the
+``Conference`` selected by ``CONFERENCE_ID``.
diff --git a/symposion_project/docs/index.rst b/symposion_project/docs/index.rst
index af2535e8..d121dded 100644
--- a/symposion_project/docs/index.rst
+++ b/symposion_project/docs/index.rst
@@ -10,11 +10,12 @@ We are in the process of cleaning things up and making them more generic.
 
 The project homepage is http://pinax.github.com/symposion/
 
-Contents:
+Apps:
 
 .. toctree::
    :maxdepth: 2
-
+   
+   conference
 
 
 Indices and tables