You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@allura.apache.org by br...@apache.org on 2015/07/08 23:06:37 UTC
[2/8] 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/be3845c3
Tree: http://git-wip-us.apache.org/repos/asf/allura/tree/be3845c3
Diff: http://git-wip-us.apache.org/repos/asf/allura/diff/be3845c3
Branch: refs/heads/db/6373
Commit: be3845c3d60e2c42e7040067590745db0c052fa2
Parents: acd50e8
Author: Dave Brondsema <da...@brondsema.net>
Authored: Tue Jul 7 16:34:18 2015 -0400
Committer: Dave Brondsema <da...@brondsema.net>
Committed: Wed Jul 8 17:00:48 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/be3845c3/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/be3845c3/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
========================