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 00:11:33 UTC
[16/16] allura git commit: [#6373] use sphinxcontrib.programoutput to
document paster commands. Improve some usage help text
[#6373] use sphinxcontrib.programoutput to document paster commands. Improve some usage help text
Project: http://git-wip-us.apache.org/repos/asf/allura/repo
Commit: http://git-wip-us.apache.org/repos/asf/allura/commit/4cd8fc31
Tree: http://git-wip-us.apache.org/repos/asf/allura/tree/4cd8fc31
Diff: http://git-wip-us.apache.org/repos/asf/allura/diff/4cd8fc31
Branch: refs/heads/db/6373
Commit: 4cd8fc31223b95489446c305a68ade0b4d49cc6f
Parents: c133e23
Author: Dave Brondsema <da...@brondsema.net>
Authored: Tue Jul 7 18:10:13 2015 -0400
Committer: Dave Brondsema <da...@brondsema.net>
Committed: Tue Jul 7 18:10:58 2015 -0400
----------------------------------------------------------------------
Allura/allura/command/show_models.py | 4 +-
Allura/allura/command/taskd_cleanup.py | 2 +-
Allura/docs/conf.py | 1 +
Allura/docs/getting_started/administration.rst | 73 ++++++++++++++++++++-
ForgeBlog/forgeblog/command/rssfeeds.py | 2 +-
ForgeChat/forgechat/command.py | 2 +-
requirements.txt | 1 +
scripts/create-allura-sitemap.py | 2 +-
8 files changed, 80 insertions(+), 7 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/allura/blob/4cd8fc31/Allura/allura/command/show_models.py
----------------------------------------------------------------------
diff --git a/Allura/allura/command/show_models.py b/Allura/allura/command/show_models.py
index d941e9e..89a2a88 100644
--- a/Allura/allura/command/show_models.py
+++ b/Allura/allura/command/show_models.py
@@ -53,7 +53,7 @@ class ReindexCommand(base.Command):
min_args = 1
max_args = 1
usage = '<ini file>'
- summary = 'Reindex and re-shortlink all artifacts'
+ summary = 'Reindex into solr and re-shortlink all artifacts'
parser = base.Command.standard_parser(verbose=True)
parser.add_option('-p', '--project', dest='project', default=None,
help='project to reindex')
@@ -203,7 +203,7 @@ class EnsureIndexCommand(base.Command):
min_args = 1
max_args = 1
usage = '[<ini file>]'
- summary = 'Run ensure_index on all mongo objects'
+ summary = 'Create all the Mongo indexes specified by Ming models, drop any unspecified indexes.'
parser = base.Command.standard_parser(verbose=True)
def command(self):
http://git-wip-us.apache.org/repos/asf/allura/blob/4cd8fc31/Allura/allura/command/taskd_cleanup.py
----------------------------------------------------------------------
diff --git a/Allura/allura/command/taskd_cleanup.py b/Allura/allura/command/taskd_cleanup.py
index 47d09bf..a796e6c 100644
--- a/Allura/allura/command/taskd_cleanup.py
+++ b/Allura/allura/command/taskd_cleanup.py
@@ -27,7 +27,7 @@ import base
class TaskdCleanupCommand(base.Command):
- summary = 'Tasks cleanup command'
+ summary = 'Tasks cleanup command. Determines which taskd processes are handling tasks, and what has been dropped or got hung.'
parser = base.Command.standard_parser(verbose=True)
parser.add_option('-k', '--kill-stuck-taskd',
dest='kill', action='store_true',
http://git-wip-us.apache.org/repos/asf/allura/blob/4cd8fc31/Allura/docs/conf.py
----------------------------------------------------------------------
diff --git a/Allura/docs/conf.py b/Allura/docs/conf.py
index 4c55afa..aa69905 100644
--- a/Allura/docs/conf.py
+++ b/Allura/docs/conf.py
@@ -42,6 +42,7 @@ import os
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx',
'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.ifconfig']
extensions += ['sphinxarg.ext']
+extensions += ['sphinxcontrib.programoutput']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
http://git-wip-us.apache.org/repos/asf/allura/blob/4cd8fc31/Allura/docs/getting_started/administration.rst
----------------------------------------------------------------------
diff --git a/Allura/docs/getting_started/administration.rst b/Allura/docs/getting_started/administration.rst
index e8952b9..b199277 100644
--- a/Allura/docs/getting_started/administration.rst
+++ b/Allura/docs/getting_started/administration.rst
@@ -70,7 +70,71 @@ running a script via this interface, the `args/kwargs` JSON should be like::
See the listing of :mod:`some available tasks <allura.tasks.admin_tasks>`.
-Available scripts and tasks are:
+
+Available scripts and commands are:
+
+
+create-neighborhood
+-------------------
+
+.. program-output:: paster create-neighborhood development.ini --help
+
+
+ensure_index
+------------
+
+.. program-output:: paster ensure_index development.ini --help
+
+
+ircbot
+------
+
+.. program-output:: paster ircbot development.ini --help
+
+
+reindex
+-------
+
+.. program-output:: paster reindex development.ini --help
+
+
+set-neighborhood-features
+-------------------------
+
+.. program-output:: paster set-neighborhood-features development.ini --help
+
+
+set-tool-access
+---------------
+
+.. program-output:: paster set-tool-access development.ini --help
+
+
+taskd
+-----
+
+.. program-output:: paster taskd development.ini --help
+
+
+taskd_cleanup
+-------------
+
+.. program-output:: paster taskd_cleanup development.ini --help
+
+
+pull-rss-feeds
+--------------
+
+Blog tools may optionally be configured to fetch external RSS feeds. If that is in place, this command should
+be used to fetch all those rss feeds and convert new entries into blog posts.
+
+Requires `html2text`, a GPL library.
+
+::
+
+ cd ../ForgeBlog
+ paster pull-rss-feeds development.ini --help
+
disable_users.py
----------------
@@ -82,6 +146,7 @@ disable_users.py
:func: get_parser
:prog: paster script development.ini allura/scripts/disable_users.py --
+
refreshrepo.py
--------------
@@ -92,6 +157,7 @@ refreshrepo.py
:func: get_parser
:prog: paster script development.ini allura/scripts/refreshrepo.py --
+
reindex_projects.py
-------------------
@@ -102,6 +168,7 @@ reindex_projects.py
:func: get_parser
:prog: paster script development.ini allura/scripts/reindex_projects.py --
+
reindex_users.py
----------------
@@ -112,6 +179,7 @@ reindex_users.py
:func: get_parser
:prog: paster script development.ini allura/scripts/reindex_users.py --
+
create-allura-sitemap.py
------------------------
@@ -122,6 +190,7 @@ create-allura-sitemap.py
:func: parser
:prog: paster script development.ini ../scripts/create-allura-sitemap.py --
+
publicize-neighborhood.py
-------------------------
@@ -132,6 +201,7 @@ publicize-neighborhood.py
:func: parser
:prog: paster script development.ini ../scripts/publicize-neighborhood.py --
+
scrub-allura-data.py
--------------------
@@ -142,6 +212,7 @@ scrub-allura-data.py
:func: parser
:prog: paster script development.ini ../scripts/scrub-allura-data.py --
+
teamforge-import.py
-------------------
http://git-wip-us.apache.org/repos/asf/allura/blob/4cd8fc31/ForgeBlog/forgeblog/command/rssfeeds.py
----------------------------------------------------------------------
diff --git a/ForgeBlog/forgeblog/command/rssfeeds.py b/ForgeBlog/forgeblog/command/rssfeeds.py
index 7771a5c..42b5edd 100644
--- a/ForgeBlog/forgeblog/command/rssfeeds.py
+++ b/ForgeBlog/forgeblog/command/rssfeeds.py
@@ -46,7 +46,7 @@ html2text.BODY_WIDTH = 0
class RssFeedsCommand(base.BlogCommand):
- summary = 'Rss feed client'
+ summary = 'Fetch external rss feeds for all Blog tools, and convert new feed entries into blog posts'
parser = base.BlogCommand.standard_parser(verbose=True)
parser.add_option('-a', '--appid', dest='appid', default='',
help='application id')
http://git-wip-us.apache.org/repos/asf/allura/blob/4cd8fc31/ForgeChat/forgechat/command.py
----------------------------------------------------------------------
diff --git a/ForgeChat/forgechat/command.py b/ForgeChat/forgechat/command.py
index 6af2eaa..da2faf8 100644
--- a/ForgeChat/forgechat/command.py
+++ b/ForgeChat/forgechat/command.py
@@ -43,7 +43,7 @@ class IRCBotCommand(allura.command.Command):
min_args = 1
max_args = 1
usage = '<ini file>'
- summary = 'Connect to all configured IRC servers and relay messages'
+ summary = 'For the ForgeChat tool. Connect to all configured IRC servers and relay messages'
parser = command.Command.standard_parser(verbose=True)
parser.add_option('-c', '--context', dest='context',
help=('The context of the message (path to the project'
http://git-wip-us.apache.org/repos/asf/allura/blob/4cd8fc31/requirements.txt
----------------------------------------------------------------------
diff --git a/requirements.txt b/requirements.txt
index eab35eb..93ef43d 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -81,3 +81,4 @@ q==2.3
WebError==0.10.3
sphinx-argparse==0.1.15
sphinx-rtd-theme==0.1.6
+sphinxcontrib-programoutput==0.8
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/allura/blob/4cd8fc31/scripts/create-allura-sitemap.py
----------------------------------------------------------------------
diff --git a/scripts/create-allura-sitemap.py b/scripts/create-allura-sitemap.py
index 29220d1..9ab8f38 100644
--- a/scripts/create-allura-sitemap.py
+++ b/scripts/create-allura-sitemap.py
@@ -16,7 +16,7 @@
# under the License.
"""
-Generate Allura sitemap xml files.
+Generate Allura sitemap xml files. You will need to configure your webserver to serve the files.
This takes a while to run on a prod-sized data set. There are a couple of
things that would make it faster, if we need/want to.