Return-Path: X-Original-To: apmail-allura-commits-archive@www.apache.org Delivered-To: apmail-allura-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id E2DC41839B for ; Tue, 7 Jul 2015 22:11:18 +0000 (UTC) Received: (qmail 3972 invoked by uid 500); 7 Jul 2015 22:11:18 -0000 Delivered-To: apmail-allura-commits-archive@allura.apache.org Received: (qmail 3926 invoked by uid 500); 7 Jul 2015 22:11:18 -0000 Mailing-List: contact commits-help@allura.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@allura.apache.org Delivered-To: mailing list commits@allura.apache.org Received: (qmail 3696 invoked by uid 99); 7 Jul 2015 22:11:18 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 07 Jul 2015 22:11:18 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 641CEE3C41; Tue, 7 Jul 2015 22:11:18 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: brondsem@apache.org To: commits@allura.apache.org Date: Tue, 07 Jul 2015 22:11:32 -0000 Message-Id: <5ab1dc005bc842d2aa946a0d9b14e444@git.apache.org> In-Reply-To: References: X-Mailer: ASF-Git Admin Mailer Subject: [15/16] allura git commit: [#6373] cross link our different APIs [#6373] cross link our different APIs Project: http://git-wip-us.apache.org/repos/asf/allura/repo Commit: http://git-wip-us.apache.org/repos/asf/allura/commit/c133e23a Tree: http://git-wip-us.apache.org/repos/asf/allura/tree/c133e23a Diff: http://git-wip-us.apache.org/repos/asf/allura/diff/c133e23a Branch: refs/heads/db/6373 Commit: c133e23a48c9d904e6be7634c7a88ca8b4f0cd02 Parents: 053627a Author: Dave Brondsema Authored: Tue Jul 7 16:34:18 2015 -0400 Committer: Dave Brondsema Committed: Tue Jul 7 18:10:57 2015 -0400 ---------------------------------------------------------------------- Allura/docs/api/index.rst | 4 ++++ Allura/docs/getting_started/administration.rst | 1 + 2 files changed, 5 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/allura/blob/c133e23a/Allura/docs/api/index.rst ---------------------------------------------------------------------- diff --git a/Allura/docs/api/index.rst b/Allura/docs/api/index.rst index 2103410..451972a 100644 --- a/Allura/docs/api/index.rst +++ b/Allura/docs/api/index.rst @@ -19,6 +19,10 @@ Allura API ********** +This documents the python classes available to Allura tools and extensions. + +If you are looking for the web REST API, see :ref:`public_api` + .. toctree:: :maxdepth: 3 http://git-wip-us.apache.org/repos/asf/allura/blob/c133e23a/Allura/docs/getting_started/administration.rst ---------------------------------------------------------------------- diff --git a/Allura/docs/getting_started/administration.rst b/Allura/docs/getting_started/administration.rst index 0b03728..e8952b9 100644 --- a/Allura/docs/getting_started/administration.rst +++ b/Allura/docs/getting_started/administration.rst @@ -200,6 +200,7 @@ users, projects, and tools on Allura. However, SourceForge has help docs that c these functions https://sourceforge.net/p/forge/documentation/Docs%20Home/ Note that this documentation also covers some SourceForge features that are not part of Allura. +.. _public_api: Public API Documentation ========================