added initial docs on speakers app and updated sphinx

This commit is contained in:
James Tauber 2012-07-12 15:53:04 -04:00
parent 3ffcc4da7c
commit 19d8b1dc7e
3 changed files with 24 additions and 1 deletions

View file

@ -17,6 +17,7 @@ Apps:
conference
sponsorship
speakers
Indices and tables

22
docs/speakers.rst Normal file
View file

@ -0,0 +1,22 @@
Speaker App
===========
The ``speaker`` app allows speakers to set up their profile, prior to or as
part of the proposal submission phase. The **dashboard** is the means through
which speakers manage their own profiles.
We are planning to make the Speaker model more pluggable so, if you have
particular fields you'd like your speakers to fill out, you'll be able to
customize things more easily.
Additional Speakers
-------------------
Because ``symposion`` supports additional speakers being attached to a
proposal or actual presentation, it has the notion of a ``Speaker`` that is
not yet a ``User`` on the site. For this reason, a ``Speaker`` may have a
NULL ``user`` field (hopefully temporarily) as well as an ``invite_email``
and ``invite_token`` field for the invitation sent to the additional speaker
to join.
.. todo:: perhaps explain the invitation flow

View file

@ -1,3 +1,3 @@
# requirements needed to build the docs
Sphinx==1.1.2
Sphinx==1.1.3