Browse Source

Added more docs

sh4nks 11 years ago
parent
commit
adad3502c2
7 changed files with 91 additions and 1 deletions
  1. 3 1
      docs/contents.rst.inc
  2. 32 0
      docs/forummodels.rst
  3. 12 0
      docs/models.rst
  4. 24 0
      docs/plugins.rst
  5. 17 0
      docs/usermodels.rst
  6. 2 0
      flaskbb/forum/models.py
  7. 1 0
      flaskbb/user/models.py

+ 3 - 1
docs/contents.rst.inc

@@ -2,6 +2,8 @@ Contents
 --------
 
 .. toctree::
-   :maxdepth: 1
+   :maxdepth: 2
 
    installation
+   models
+   plugins

+ 32 - 0
docs/forummodels.rst

@@ -0,0 +1,32 @@
+Forum Models
+------------
+
+.. module:: flaskbb.forum.models
+
+.. autoclass:: Category
+   :members:
+   :inherited-members:
+
+.. autoclass:: Forum
+   :members:
+   :inherited-members:
+
+.. autoclass:: Topic
+   :members:
+   :inherited-members:
+
+.. autoclass:: Post
+   :members:
+   :inherited-members:
+
+.. autoclass:: TopicsRead
+   :members:
+   :inherited-members:
+
+.. autoclass:: ForumsRead
+   :members:
+   :inherited-members:
+
+.. autoclass:: Report
+   :members:
+   :inherited-members:

+ 12 - 0
docs/models.rst

@@ -0,0 +1,12 @@
+.. _models:
+
+Available Models
+================
+
+Here you can see a all available models.
+
+.. toctree::
+   :maxdepth: 1
+
+   forummodels
+   usermodels

+ 24 - 0
docs/plugins.rst

@@ -0,0 +1,24 @@
+.. _plugins:
+
+Plugin API
+==========
+
+.. module:: flaskbb.plugins
+
+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
+   :members:
+   :inherited-members:

+ 17 - 0
docs/usermodels.rst

@@ -0,0 +1,17 @@
+User Models
+-----------
+
+.. module:: flaskbb.user.models
+
+.. autoclass:: User
+   :members:
+   :inherited-members:
+
+.. autoclass:: Group
+   :members:
+   :inherited-members:
+
+.. autoclass:: PrivateMessage
+   :members:
+   :inherited-members:
+

+ 2 - 0
flaskbb/forum/models.py

@@ -868,6 +868,7 @@ class Category(db.Model):
         and their associated forums (whose are stored in a list).
 
         For example::
+
             [(<Category 1>, [(<Forum 2>, <ForumsRead>), (<Forum 1>, None)]),
              (<Category 2>, [(<Forum 3>, None), (<Forum 4>, None)])]
 
@@ -901,6 +902,7 @@ class Category(db.Model):
         forumsread object are stored in a list.
 
         A return value can look like this for a category with two forums::
+
             (<Category 1>, [(<Forum 1>, None), (<Forum 2>, None)])
 
         :param category_id: The category id

+ 1 - 0
flaskbb/user/models.py

@@ -422,6 +422,7 @@ class PrivateMessage(db.Model):
         self.user_id = user_id
         self.from_user_id = from_user
         self.to_user_id = to_user
+        self.date_created = datetime.utcnow()
 
         db.session.add(self)
         db.session.commit()