|
a |
|
b/ForgeImporters/docs/framework.rst |
|
|
1 |
.. Licensed to the Apache Software Foundation (ASF) under one
|
|
|
2 |
or more contributor license agreements. See the NOTICE file
|
|
|
3 |
distributed with this work for additional information
|
|
|
4 |
regarding copyright ownership. The ASF licenses this file
|
|
|
5 |
to you under the Apache License, Version 2.0 (the
|
|
|
6 |
"License"); you may not use this file except in compliance
|
|
|
7 |
with the License. You may obtain a copy of the License at
|
|
|
8 |
|
|
|
9 |
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
10 |
|
|
|
11 |
Unless required by applicable law or agreed to in writing,
|
|
|
12 |
software distributed under the License is distributed on an
|
|
|
13 |
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
|
14 |
KIND, either express or implied. See the License for the
|
|
|
15 |
specific language governing permissions and limitations
|
|
|
16 |
under the License.
|
|
|
17 |
|
|
|
18 |
:mod:`forgeimporters.base`
|
|
|
19 |
==========================
|
|
|
20 |
|
|
|
21 |
The following classes make up the base framework for
|
|
|
22 |
importers.
|
|
|
23 |
|
|
|
24 |
These can be used to create additional importers
|
|
|
25 |
for Allura, which can be made available by creating an
|
|
|
26 |
appropriate entry-point under `allura.project_importers` or
|
|
|
27 |
`allura.importers` for project importers or tool importers,
|
|
|
28 |
respectively.
|
|
|
29 |
|
|
|
30 |
:class:`~forgeimporters.base.ProjectImporter`
|
|
|
31 |
---------------------------------------------
|
|
|
32 |
|
|
|
33 |
.. autoclass:: forgeimporters.base.ProjectImporter
|
|
|
34 |
:members:
|
|
|
35 |
|
|
|
36 |
:class:`~forgeimporters.base.ToolImporter`
|
|
|
37 |
------------------------------------------
|
|
|
38 |
|
|
|
39 |
.. autoclass:: forgeimporters.base.ToolImporter
|
|
|
40 |
:members:
|
|
|
41 |
|
|
|
42 |
:class:`~forgeimporters.base.ToolsValidator`
|
|
|
43 |
--------------------------------------------
|
|
|
44 |
|
|
|
45 |
.. autoclass:: forgeimporters.base.ToolsValidator
|
|
|
46 |
:members:
|