7f57de5bb2
Document in which version new types and functions were added using ".. versionadded:: x.y". Document changes using ".. versionchanged:: x.y." For new modules, add the versionadded tag in the module top docstring, not on each type/function. Add fileutils to documentation. The doc part was forgotten during the graduation. Add docstrings to convert versions of versionutils. I used "git blame" + "git tag --contains=SHA1" to find these version, and then I checked manually each version. Change-Id: Ia2f00aa29eb36410a49fc1d350896a569a7737a1
59 lines
921 B
ReStructuredText
59 lines
921 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/encodeutils
|
|
api/eventletutils
|
|
api/excutils
|
|
api/fileutils
|
|
api/fixture
|
|
api/importutils
|
|
api/netutils
|
|
api/reflection
|
|
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
|