Commits

fab31  committed ce74026

Documentation cleanup

  • Participants
  • Parent commits e32a764

Comments (0)

Files changed (9)

File docs/source/_static/_keep_me

Empty file added.

File docs/source/apis/drink.ListPage.rst

    .. autosummary::
    
       ~ListPage.__init__
-      ~ListPage.add
-      ~ListPage.borrow
-      ~ListPage.clear
-      ~ListPage.copy
-      ~ListPage.edit
-      ~ListPage.fromkeys
-      ~ListPage.gallery
-      ~ListPage.get
-      ~ListPage.get_field
-      ~ListPage.has_key
-      ~ListPage.items
-      ~ListPage.iteritems
-      ~ListPage.iterkeys
-      ~ListPage.itervalues
-      ~ListPage.keys
-      ~ListPage.list
-      ~ListPage.match
-      ~ListPage.move
-      ~ListPage.pop
-      ~ListPage.popitem
       ~ListPage.reset_items
-      ~ListPage.rm
-      ~ListPage.serialize
-      ~ListPage.set_field
-      ~ListPage.setdefault
-      ~ListPage.struct
-      ~ListPage.update
-      ~ListPage.upload
-      ~ListPage.values
-      ~ListPage.view
-   
-   
 
    
-   
-   .. rubric:: Attributes
-
-   .. autosummary::
-   
-      ~ListPage.actions
-      ~ListPage.admin_fields
-      ~ListPage.classes
-      ~ListPage.css
-      ~ListPage.default_action
-      ~ListPage.description
-      ~ListPage.drink_name
-      ~ListPage.editable_fields
-      ~ListPage.forced_order
-      ~ListPage.hidden_class
-      ~ListPage.html
-      ~ListPage.indexable
-      ~ListPage.items_factory
-      ~ListPage.js
-      ~ListPage.mime
-      ~ListPage.min_rights
-      ~ListPage.owner_fields
-      ~ListPage.path
-      ~ListPage.quoted_id
-      ~ListPage.quoted_path
-      ~ListPage.upload_map
-   
-   

File docs/source/apis/drink.Page.rst

 
    
    .. automethod:: __init__
+   .. automethod:: _edit
 
    
    .. rubric:: Methods
       ~Page.clear
       ~Page.copy
       ~Page.edit
+      ~Page._edit
       ~Page.fromkeys
       ~Page.gallery
       ~Page.get
    
    .. rubric:: Attributes
 
+   .. autoattribute:: _items_factory
+   .. autoattribute:: _loaders
+   .. autoattribute:: _actions
+   .. autoattribute:: _add_hooks
+   .. autoattribute:: _remove_hooks
+
    .. autosummary::
    
-      ~Page.actions
+      ~Page.editable_fields
       ~Page.admin_fields
+      ~Page.owner_fields
       ~Page.classes
       ~Page.css
+      ~Page.html
+      ~Page.js
+      ~Page.description
+      ~Page.hidden_class
+      ~Page.indexable
+      ~Page._items_factory
+      ~Page._add_hooks
+      ~Page._remove_hooks
+      ~Page._loaders
       ~Page.default_action
-      ~Page.description
-      ~Page.editable_fields
-      ~Page.hidden_class
-      ~Page.html
-      ~Page.indexable
-      ~Page.items_factory
-      ~Page.js
+      ~Page._actions
       ~Page.mime
       ~Page.min_rights
-      ~Page.owner_fields
       ~Page.path
       ~Page.quoted_id
       ~Page.quoted_path
       ~Page.upload_map
    
-   
+   

File docs/source/apis/drink.objects.generic.WebFile.rst

 
 .. currentmodule:: drink.objects.generic
 
-.. autodata:: WebFile
+.. autoclass:: WebFile

File docs/source/apis/drink.types.rst

    
    .. rubric:: Classes
 
+   .. autoclass:: _Editable
+
    .. autosummary::
    
+      _Editable
       BoolOption
       CheckboxSet
       Choice

File docs/source/conf.py

 autosummary_generate = True
 autoclass_content = "both"
 autodoc_member_order = "bysource"
-autodoc_default_flags = ('members', 'undoc-members', 'show-inheritance', 'inherited')
+autodoc_default_flags = ('members', 'undoc-members', 'show-inheritance') #, 'inherited')
 

File docs/source/developpers.rst

    finder.ObjectBrowser
    filesystem.Filesystem
    sonic.SonicHome
+

File drink/types.py

     'Text', 'TextArea', 'GroupListArea', 'GroupCheckBoxes',
     'CheckboxSet', 'BoolOption',
     'Mime', 'Choice', 'Link',
-    'Date',
-    'Id', 'Int', 'Password', 'File']
+    'Date', 'Duration', 'EasyPermissions',
+    'Id', 'Float', 'Int', 'Password', 'File']
 
 import os
 import drink
 from time import mktime, strptime
 
 class _Editable(object):
+    """ Abstract class for any editable type """
 
     form_attr = None
 

File drink_defaults/database/zeo.conf

 # replace "database" with full path of database folder
-%define DATADIR database
+%define DATADIR /tmp/foo_/database/
 <zeo>
   address ${DATADIR}zeo.sock
   read-only false