Changeset - 19d8b1dc7e72
[Not reviewed]
0 2 1
James Tauber - 12 years ago 2012-07-12 19:53:04
jtauber@jtauber.com
added initial docs on speakers app and updated sphinx
3 files changed with 24 insertions and 1 deletions:
0 comments (0 inline, 0 general)
docs/index.rst
Show inline comments
...
 
@@ -17,6 +17,7 @@ Apps:
 
   
 
   conference
 
   sponsorship
 
   speakers
 

	
 

	
 
Indices and tables
docs/speakers.rst
Show inline comments
 
new file 100644
 
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
requirements/docs.txt
Show inline comments
 
# requirements needed to build the docs
 

	
 
Sphinx==1.1.2
 
Sphinx==1.1.3
0 comments (0 inline, 0 general)