web/views/startup.py
branchstable
changeset 7897 defac26f4151
parent 7681 32c4c9bab046
child 7990 a673d1d9a738
--- a/web/views/startup.py	Thu Sep 29 15:28:41 2011 +0200
+++ b/web/views/startup.py	Fri Sep 30 11:15:40 2011 +0200
@@ -15,8 +15,10 @@
 #
 # You should have received a copy of the GNU Lesser General Public License along
 # with CubicWeb.  If not, see <http://www.gnu.org/licenses/>.
-"""Set of HTML startup views. A startup view is global, e.g. doesn't apply to a
-result set.
+"""This module contains the default index page and management view.
+
+.. autoclass:: IndexView
+.. autoclass:: ManageView
 """
 
 __docformat__ = "restructuredtext en"
@@ -32,6 +34,19 @@
 from cubicweb.web import ajax_replace_url, uicfg, httpcache
 
 class ManageView(StartupView):
+    """:__regid__: *manage*
+
+    The manage view, display some information about what's contained by your
+    site and provides access to administration stuff such as user and groups
+    management.
+
+    Regarding the section displaying link to entity type, notice by default it
+    won't display entity types which are related to another one using a
+    mandatory (cardinality == 1) composite relation.
+
+    You can still configure that behaviour manually using the
+    `indexview_etype_section` as explained in :mod:`cubicweb.web.uicfg`.
+    """
     __regid__ = 'manage'
     title = _('manage')
     http_cache_manager = httpcache.EtagHTTPCacheManager
@@ -149,6 +164,13 @@
 
 
 class IndexView(ManageView):
+    """:__regid__: *index*
+
+    The default index view, that you'll get when accessing your site's root url.
+    It's by default indentical to the
+    :class:`~cubicweb.web.views.startup.ManageView`, but you'll usually want to
+    customize this one.
+    """
     __regid__ = 'index'
     title = _('view_index')