Return-Path: X-Original-To: apmail-incubator-allura-commits-archive@minotaur.apache.org Delivered-To: apmail-incubator-allura-commits-archive@minotaur.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 9DD10101E5 for ; Wed, 24 Apr 2013 04:54:20 +0000 (UTC) Received: (qmail 78366 invoked by uid 500); 24 Apr 2013 04:54:17 -0000 Delivered-To: apmail-incubator-allura-commits-archive@incubator.apache.org Received: (qmail 78264 invoked by uid 500); 24 Apr 2013 04:54:16 -0000 Mailing-List: contact allura-commits-help@incubator.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: allura-dev@incubator.apache.org Delivered-To: mailing list allura-commits@incubator.apache.org Received: (qmail 76955 invoked by uid 99); 24 Apr 2013 04:54:09 -0000 Received: from tyr.zones.apache.org (HELO tyr.zones.apache.org) (140.211.11.114) by apache.org (qpsmtpd/0.29) with ESMTP; Wed, 24 Apr 2013 04:54:09 +0000 Received: by tyr.zones.apache.org (Postfix, from userid 65534) id 6BF4E8238FF; Wed, 24 Apr 2013 04:54:09 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: tvansteenburgh@apache.org To: allura-commits@incubator.apache.org Date: Wed, 24 Apr 2013 04:54:53 -0000 Message-Id: <1b7c870a243f4aa19ef7c3a4921f9242@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [48/50] [abbrv] git commit: Getting started with sphinx api docs Getting started with sphinx api docs Signed-off-by: Tim Van Steenburgh 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 Authored: Fri Apr 12 22:47:06 2013 +0000 Committer: Tim Van Steenburgh 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::