incubator-allura-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From tvansteenbu...@apache.org
Subject [48/50] [abbrv] git commit: Getting started with sphinx api docs
Date Wed, 24 Apr 2013 04:54:53 GMT
Getting started with sphinx api docs

Signed-off-by: Tim Van Steenburgh <tvansteenburgh@gmail.com>


Project: http://git-wip-us.apache.org/repos/asf/incubator-allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-allura/commit/2829f476
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/2829f476
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/2829f476

Branch: refs/heads/tv/docs
Commit: 2829f4767ce86f7577e35ac02fc3d8b1914dd653
Parents: e6136bd
Author: Tim Van Steenburgh <tvansteenburgh@gmail.com>
Authored: Fri Apr 12 22:47:06 2013 +0000
Committer: Tim Van Steenburgh <tvansteenburgh@gmail.com>
Committed: Tue Apr 23 23:39:22 2013 -0400

----------------------------------------------------------------------
 Allura/allura/app.py    |    8 +++++++-
 Allura/docs/api/app.rst |   11 +++++++++++
 Allura/docs/index.rst   |    9 +++++++++
 3 files changed, 27 insertions(+), 1 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/2829f476/Allura/allura/app.py
----------------------------------------------------------------------
diff --git a/Allura/allura/app.py b/Allura/allura/app.py
index 18dbf59..b89285e 100644
--- a/Allura/allura/app.py
+++ b/Allura/allura/app.py
@@ -208,7 +208,13 @@ class Application(object):
         return False
 
     def is_visible_to(self, user):
-        '''Whether the user can view the app.'''
+        """Return whether ``user`` can view this app.
+
+        :param user: user to check
+        :type user: :class:`allura.model.User` instance
+        :rtype: bool
+
+        """
         return has_access(self, 'read')(user=user)
 
     def subscribe_admins(self):

http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/2829f476/Allura/docs/api/app.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/api/app.rst b/Allura/docs/api/app.rst
new file mode 100644
index 0000000..688a8fa
--- /dev/null
+++ b/Allura/docs/api/app.rst
@@ -0,0 +1,11 @@
+.. _app_module:
+
+:mod:`allura.app`
+--------------------------------
+
+.. automodule:: allura.app
+
+  .. autoclass:: Application
+      :members:
+      :inherited-members:
+      :undoc-members:

http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/2829f476/Allura/docs/index.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/index.rst b/Allura/docs/index.rst
index ea20734..5063dac 100644
--- a/Allura/docs/index.rst
+++ b/Allura/docs/index.rst
@@ -58,6 +58,15 @@ Inside the Platform Components
    guides/email
    guides/permissions
 
+API Documentation
+==================
+
+.. toctree::
+   :maxdepth: 1
+      :glob:
+
+      api/*
+
 Frequently Asked Questions
 =====================================================================
 .. toctree::


Mime
View raw message