This is an automated email from the ASF dual-hosted git repository.
brondsem pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/allura.git
The following commit(s) were added to refs/heads/master by this push:
new 3da11b88b fix sphinx documentation issues
3da11b88b is described below
commit 3da11b88be9ebef93f05e0879ed9563816c5ea83
Author: Dave Brondsema <dbronds...@slashdotmedia.com>
AuthorDate: Wed Sep 14 16:47:54 2022 -0400
fix sphinx documentation issues
---
Allura/allura/command/show_models.py | 3 ++-
Allura/allura/lib/plugin.py | 3 +--
Allura/allura/model/artifact.py | 2 +-
Allura/docs/api/lib/security.rst | 1 +
Allura/docs/getting_started/install_each_step.rst | 5 ++---
ForgeImporters/forgeimporters/base.py | 2 +-
6 files changed, 8 insertions(+), 8 deletions(-)
diff --git a/Allura/allura/command/show_models.py
b/Allura/allura/command/show_models.py
index 5e2175350..6357d8e03 100644
--- a/Allura/allura/command/show_models.py
+++ b/Allura/allura/command/show_models.py
@@ -54,7 +54,8 @@ class ReindexCommand(base.Command):
min_args = 1
max_args = 1
usage = '<ini file>'
- summary = 'Reindex into solr and re-shortlink all artifacts'
+ summary = 'Reindex into solr and re-shortlink all artifacts\n' \
+ 'By default both --refs and --tasks are enabled, but if you
specify just one, the other will be disabled'
parser = base.Command.standard_parser(verbose=True)
parser.add_option('-p', '--project', dest='project', default=None,
help='project to reindex')
diff --git a/Allura/allura/lib/plugin.py b/Allura/allura/lib/plugin.py
index b1d47e3f2..fe2a97c52 100644
--- a/Allura/allura/lib/plugin.py
+++ b/Allura/allura/lib/plugin.py
@@ -888,8 +888,7 @@ class ProjectRegistrationProvider:
Returns True if one of the following is true:
- phone verification is disabled
- :param user: has 'admin' access to :param neighborhood:
- - :param user: is has 'admin' access for some project, which
belongs
- to :param neighborhood:
+ - :param user: is has 'admin' access for some project, which
belongs to :param neighborhood:
- phone is already verified for a :param user:
Otherwise returns False.
diff --git a/Allura/allura/model/artifact.py b/Allura/allura/model/artifact.py
index 6ff629e68..487530f9d 100644
--- a/Allura/allura/model/artifact.py
+++ b/Allura/allura/model/artifact.py
@@ -445,7 +445,7 @@ class Artifact(MappedClass, SearchIndexable):
:param filename: file name
:param fp: a file-like object (implements ``read()``)
- :param **kw: passed through to Attachment class constructor
+ :param kw: passed through to Attachment class constructor
"""
att = self.attachment_class().save_attachment(
diff --git a/Allura/docs/api/lib/security.rst b/Allura/docs/api/lib/security.rst
index 08c9ba4fb..42877572a 100644
--- a/Allura/docs/api/lib/security.rst
+++ b/Allura/docs/api/lib/security.rst
@@ -24,3 +24,4 @@
.. autoclass:: RoleCache
:members:
:special-members: __init__
+ :noindex:
diff --git a/Allura/docs/getting_started/install_each_step.rst
b/Allura/docs/getting_started/install_each_step.rst
index 5014022a3..395a6dcec 100644
--- a/Allura/docs/getting_started/install_each_step.rst
+++ b/Allura/docs/getting_started/install_each_step.rst
@@ -24,9 +24,6 @@ Step-by-Step Installation
.. contents::
:local:
-Step-by-Step Installation
--------------------------
-
For a simpler setup using Docker images, see :ref:`docker-install` instead.
In these instructions, we'll use `VirtualBox <http://www.virtualbox.org>`__
and `Ubuntu 18.04 <http://ubuntu.com>`_ to create a disposable sandbox for
Allura development/testing. Allura should work on other Linux systems
(including OSX), but setting up all the dependencies will be different.
@@ -62,6 +59,7 @@ To install MongoDB, follow the instructions `here
<https://docs.mongodb.org/manu
Optional, for SVN support:
.. code-block:: bash
+
~$ sudo apt-get install subversion libsvn-dev make g++ python3-svn
Setting up a python virtual environment
@@ -122,6 +120,7 @@ This may take a little while.
Optional, for SVN support: install the wheel package then use the
pysvn-installer script to build a pysvn wheel.
.. code-block:: bash
+
(env-allura)~/src/allura$ pip install wheel
(env-allura)~/src/allura$ curl
https://raw.githubusercontent.com/reviewboard/pysvn-installer/master/install.py
| python
diff --git a/ForgeImporters/forgeimporters/base.py
b/ForgeImporters/forgeimporters/base.py
index 0d9d359e9..4cdf67dba 100644
--- a/ForgeImporters/forgeimporters/base.py
+++ b/ForgeImporters/forgeimporters/base.py
@@ -334,7 +334,7 @@ class ProjectImporter(BaseController):
tool imports happen.
:param project: The newly created project.
- :param **kw: The keyword arguments that were posted to the controller
+ :param kw: The keyword arguments that were posted to the controller
method that created the project.
"""
