neutron-lib/doc/source/devref/index.rst
Paul Michali 7d9980f7ca API validators and converters
This brings over the validation and convert_to methods from Neutron.
Additional tests were added to improve coverage, and some supporting
methods were added for these.

Renamed validators to remove underscore, so that they can be imported
into neutron/api/v2/attributes.py.

Added devref docs to help developers in creating and using validators
and converters.

Change-Id: I81394dff69b816146e521bcd3e9641761178d6fd
Implements: blueprint neutron-lib
2016-01-15 12:44:09 +00:00

56 lines
1.4 KiB
ReStructuredText

..
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.
Convention for heading levels in Neutron lib devref:
======= Heading 0 (reserved for the title in a document)
------- Heading 1
~~~~~~~ Heading 2
+++++++ Heading 3
''''''' Heading 4
(Avoid deeper levels because they do not render well.)
Developer Guide
===============
In the Developer Guide, you will find information on the Neutron Library
components and in how to use them, from a development standpoint.
Neutron Lib Internals
---------------------
.. toctree::
:maxdepth: 3
api_converters
api_validators
callbacks
Module Reference
----------------
.. toctree::
:maxdepth: 3
.. todo::
Add in all the big modules as automodule indexes.
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`