You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@allura.apache.org by tv...@apache.org on 2013/11/22 14:34:12 UTC
git commit: Docs cleanup
Updated Branches:
refs/heads/master 4386d93c3 -> b53e49a33
Docs cleanup
Restore missing allura.app api docs, and cleanup various sphinx
build warnings.
Signed-off-by: Tim Van Steenburgh <tv...@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/b53e49a3
Tree: http://git-wip-us.apache.org/repos/asf/incubator-allura/tree/b53e49a3
Diff: http://git-wip-us.apache.org/repos/asf/incubator-allura/diff/b53e49a3
Branch: refs/heads/master
Commit: b53e49a33a63f08dee12c5c8696529567061aee8
Parents: 4386d93
Author: Tim Van Steenburgh <tv...@gmail.com>
Authored: Fri Nov 22 13:33:58 2013 +0000
Committer: Tim Van Steenburgh <tv...@gmail.com>
Committed: Fri Nov 22 13:33:58 2013 +0000
----------------------------------------------------------------------
Allura/allura/ext/admin/admin_main.py | 41 +++++++++++++++---------------
Allura/allura/tasks/admin_tasks.py | 12 +++++----
Allura/docs/api/app.rst | 1 -
Allura/docs/scm_host.rst | 2 +-
4 files changed, 29 insertions(+), 27 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/b53e49a3/Allura/allura/ext/admin/admin_main.py
----------------------------------------------------------------------
diff --git a/Allura/allura/ext/admin/admin_main.py b/Allura/allura/ext/admin/admin_main.py
index 4643be6..f559da9 100644
--- a/Allura/allura/ext/admin/admin_main.py
+++ b/Allura/allura/ext/admin/admin_main.py
@@ -728,26 +728,27 @@ class ProjectAdminRestController(BaseController):
def install_tool(self, tool=None, mount_point=None, mount_label=None, **kw):
"""API for installing tools in current project.
- Requires a valid tool, mount point and mount label names.
- (All arguments are required.)
-
- Usage example::
- POST to:
- /rest/p/testproject/admin/install_tool/
-
- with params:
- {
- 'tool': 'tickets',
- 'mount_point': 'mountpoint',
- 'mount_label': 'mountlabel'
- }
-
- Example output (in successful case)::
-
- {
- "info": "Tool tickets with mount_point mountpoint and mount_label mountlabel was created.",
- "success": true
- }
+ Requires a valid tool, mount point and mount label names.
+ (All arguments are required.)
+
+ Usage example::
+
+ POST to:
+ /rest/p/testproject/admin/install_tool/
+
+ with params:
+ {
+ 'tool': 'tickets',
+ 'mount_point': 'mountpoint',
+ 'mount_label': 'mountlabel'
+ }
+
+ Example output (in successful case)::
+
+ {
+ "info": "Tool tickets with mount_point mountpoint and mount_label mountlabel was created.",
+ "success": true
+ }
"""
controller = ProjectAdminController()
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/b53e49a3/Allura/allura/tasks/admin_tasks.py
----------------------------------------------------------------------
diff --git a/Allura/allura/tasks/admin_tasks.py b/Allura/allura/tasks/admin_tasks.py
index e8b67c0..44ed421 100644
--- a/Allura/allura/tasks/admin_tasks.py
+++ b/Allura/allura/tasks/admin_tasks.py
@@ -25,13 +25,15 @@ from allura.lib.decorators import task
@task
def install_app(*args, **kwargs):
- '''
- Install an application directly onto c.project, bypassing the UI and any app
- constraints like installable=False
- '''
+ """Install an application directly onto c.project, bypassing the UI and
+ any app constraints like ``installable=False``.
+
+ """
c.project.install_app(*args, **kwargs)
install_app.__doc__ += '''
- Arguments: ''' + inspect.formatargspec(*inspect.getargspec(
+ Arguments::
+
+ ''' + inspect.formatargspec(*inspect.getargspec(
M.Project.install_app
)).replace('self, ','')
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/b53e49a3/Allura/docs/api/app.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/api/app.rst b/Allura/docs/api/app.rst
index f99a0c2..e9ae15f 100644
--- a/Allura/docs/api/app.rst
+++ b/Allura/docs/api/app.rst
@@ -21,5 +21,4 @@
--------------------------------
.. automodule:: allura.app
-
:members:
http://git-wip-us.apache.org/repos/asf/incubator-allura/blob/b53e49a3/Allura/docs/scm_host.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/scm_host.rst b/Allura/docs/scm_host.rst
index 5dab400..fa61ef7 100644
--- a/Allura/docs/scm_host.rst
+++ b/Allura/docs/scm_host.rst
@@ -74,7 +74,7 @@ These instructions are based on the documentation in `Debootstrap Chroot`_. and
Configure OpenLDAP in the Chroot
--------------------------------------------------------------
-#. Copy the ldap-setup script into the chroot environment
+#. Copy the ldap-setup script into the chroot environment::
$ sudo cp Allura/ldap-setup.py Allura/ldap-userconfig.py /var/chroots/scm
$ sudo chmod +x /var/chroots/scm/ldap-*.py