manila/doc/source/devref/manila.rst
Danny Al-Gaaf a8ec3317be doc: verify all rst files
Make use of doc8 to verify all rst files which are not
autogenerated for errors and fail if there are any issues
found. The doc8 checks are now part of the tox 'docs'
environment and ran automatically. Checks can also be called
direcly via 'tox -e docs'.

Fix all issues found by doc8.

Closes-Bug: #1664841

Change-Id: I9215524d35646de7485504e4c5ff86fd91a1d09f
Signed-off-by: Danny Al-Gaaf <danny.al-gaaf@bisect.de>
2017-02-15 07:07:42 +01:00

86 lines
1.9 KiB
ReStructuredText

..
Copyright 2010-2011 United States Government as represented by the
Administrator of the National Aeronautics and Space Administration.
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.
Common and Misc Libraries
=========================
Libraries common throughout manila or just ones that haven't yet been
categorized in depth.
The :mod:`manila.context` Module
--------------------------------
.. automodule:: manila.context
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.exception` Module
----------------------------------
.. automodule:: manila.exception
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.test` Module
-----------------------------
.. automodule:: manila.test
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.utils` Module
------------------------------
.. automodule:: manila.utils
:noindex:
:members:
:undoc-members:
:show-inheritance:
The :mod:`manila.wsgi` Module
-----------------------------
.. automodule:: manila.wsgi
:noindex:
:members:
:undoc-members:
:show-inheritance:
Tests
-----
The :mod:`test_exception` Module
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. automodule:: manila.tests.test_exception
:noindex:
:members:
:undoc-members:
:show-inheritance: