3e1d9894e9
ARMADA-239: Documentation for validation error codes for Armada
3 of 3 commits (Inital Setup and Remaining Exceptions are in seperate commits)
-guide-exceptions.rst contains the files to include in the documentation.
-docs/.../exceptions files contains the format and content of the documenation.
-armada/exceptions files were modified in their comments in order to utilize the
sphinx-directed method.
Please Note: If the exception is not raised anywhere, it is not included in the
documentation.
Change-Id: Ie093cb3252b199bfc7fcd62284501e573d89ed8a
48 lines
1.6 KiB
C++
48 lines
1.6 KiB
C++
..
|
|
Copyright 2017 AT&T Intellectual Property.
|
|
All Rights Reserved.
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License"); you may
|
|
not use this file except in compliance with the License. You may obtain
|
|
a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
License for the specific language governing permissions and limitations
|
|
under the License.
|
|
|
|
.. list-table:: **Source Exceptions**
|
|
:widths: 5 50
|
|
:header-rows: 1
|
|
|
|
* - Exception Name
|
|
- Description
|
|
* - ChartSourceException
|
|
- .. autoexception:: armada.exceptions.source_exceptions.ChartSourceException
|
|
:members:
|
|
:show-inheritance:
|
|
:undoc-members:
|
|
* - GitException
|
|
- .. autoexception:: armada.exceptions.source_exceptions.GitException
|
|
:members:
|
|
:show-inheritance:
|
|
:undoc-members:
|
|
* - InvalidPathException
|
|
- .. autoexception:: armada.exceptions.source_exceptions.InvalidPathException
|
|
:members:
|
|
:show-inheritance:
|
|
:undoc-members:
|
|
* - TarballDownloadException
|
|
- .. autoexception:: armada.exceptions.source_exceptions.TarballDownloadException
|
|
:members:
|
|
:show-inheritance:
|
|
:undoc-members:
|
|
* - TarballExtractException
|
|
- .. autoexception:: armada.exceptions.source_exceptions.TarballExtractException
|
|
:members:
|
|
:show-inheritance:
|
|
:undoc-members:
|