oslo.utils/doc/source/index.rst
Hanxi Liu 7b7d5b9e80 Create dictutils and add 'flatten_dict_to_keypairs'
This function has been shared at least kwapi and all Telemetry projects
including ceilometer, aodh, panko and gnocchi. As a generator, it produces
sequence of keypairs for nested dictionaries. It seems to be good moving it
to the common shared code.

So add an initial dictutils and tests for it.

Change-Id: Ibd7c2ce4ef9c2608910b26169a804eb463759c7f
2016-11-01 23:35:57 +08:00

64 lines
1011 B
ReStructuredText

======================================
Welcome to oslo.utils's documentation!
======================================
The `oslo`_ utils library provides support for common utility type functions,
such as encoding, exception handling, string manipulation, and time handling.
.. toctree::
:maxdepth: 1
installation
usage
contributing
API Documentation
=================
.. toctree::
:maxdepth: 2
api/dictutils
api/encodeutils
api/eventletutils
api/excutils
api/fileutils
api/fixture
api/fnmatch
api/imageutils
api/importutils
api/netutils
api/reflection
api/secretutils
api/specs_matcher
api/strutils
api/timeutils
api/units
api/uuidutils
api/versionutils
Examples
========
.. toctree::
:maxdepth: 2
examples/timeutils
Release Notes
=============
.. toctree::
:maxdepth: 1
history
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. _oslo: https://wiki.openstack.org/wiki/Oslo