6e04f882c4
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as errors is setting warning-is-error in build_sphinx section. Migrate the setting from the old warnerrors one. There are two issues: - The `*` character is recognized as an emphasis character and must be escaped - The index references modules that have since been removed These are resolved. Change-Id: Id078022c0f75bf8f162b693d260f67116eb6428b
62 lines
978 B
ReStructuredText
62 lines
978 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/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
|