Browse Source

Updated docs.

sh4nks 11 years ago
parent
commit
f1b5343237
2 changed files with 5 additions and 11 deletions
  1. 1 10
      docs/plugins.rst
  2. 4 1
      flaskbb/plugins/__init__.py

+ 1 - 10
docs/plugins.rst

@@ -10,15 +10,6 @@ This part of the documenation explains how to create and use plugins.
 Plugin Class
 ------------
 
-.. autoclass:: Plugin
-   :members:
-   :inherited-members:
-
-
-Plugin Loader
--------------
-
-.. module:: flaskbb.plugins.loader
-.. autoclass:: PluginLoader
+.. autoclass:: FlaskBBPlugin
    :members:
    :inherited-members:

+ 4 - 1
flaskbb/plugins/__init__.py

@@ -6,17 +6,20 @@ from flaskbb.admin.models import SettingsGroup
 
 class FlaskBBPlugin(Plugin):
 
-    #: Set this to true if the plugin needs to install additional things
+    #: This is the :class:`SettingsGroup` key - if your the plugin needs to install
+    #: additional things you must set it, else it won't install anything.
     settings_key = None
 
     @property
     def installable(self):
+        """Is ``True`` if the Plugin can be installed."""
         if self.settings_key is not None:
             return True
         return False
 
     @property
     def uninstallable(self):
+        """Is ``True`` if the Plugin can be uninstalled."""
         if self.installable:
             group = SettingsGroup.query.filter_by(key=self.settings_key).first()
             if group and len(group.settings.all()) > 0: