diff options
author | Joshua Harlow <harlowja@yahoo-inc.com> | 2015-04-07 13:35:01 -0700 |
---|---|---|
committer | Joshua Harlow <harlowja@yahoo-inc.com> | 2015-04-07 18:19:37 -0700 |
commit | cb88d17a365fb8865c4e7cfd7a2d431b8e920cad (patch) | |
tree | 1dc2330941ff40089d941f5c906b3d15cb9b5c66 /doc | |
parent | 6ab5ae239fb3cd0f5a10b8fcaf721981637ebf56 (diff) | |
download | oslo-utils-cb88d17a365fb8865c4e7cfd7a2d431b8e920cad.tar.gz |
Add pypi download + version badges
Also makes the docs look more like the other
oslo libraries so that the content is easily readable
across projects.
Change-Id: I85158a89f103cdef2afa268558592c46ce6c3411
Diffstat (limited to 'doc')
-rw-r--r-- | doc/source/api/index.rst | 9 | ||||
-rw-r--r-- | doc/source/index.rst | 26 | ||||
-rw-r--r-- | doc/source/readme.rst | 1 |
3 files changed, 22 insertions, 14 deletions
diff --git a/doc/source/api/index.rst b/doc/source/api/index.rst deleted file mode 100644 index f193e3b..0000000 --- a/doc/source/api/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -===== - API -===== - -.. toctree:: - :maxdepth: 2 - :glob: - - * diff --git a/doc/source/index.rst b/doc/source/index.rst index 1dce4d7..6298026 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,21 +1,39 @@ +====================================== Welcome to oslo.utils's documentation! ====================================== -Contents: +The `oslo`_ utils library provides support for common utility type functions, +such as encoding, exception handling, string manipulation, and time handling. .. toctree:: - :maxdepth: 2 + :maxdepth: 1 - readme installation usage - api/index contributing history +API Documentation +================= + +.. toctree:: + :maxdepth: 2 + + api/encodeutils + api/eventletutils + api/excutils + api/fixture + api/importutils + api/netutils + api/strutils + api/timeutils + api/units + Indices and tables ================== * :ref:`genindex` * :ref:`modindex` * :ref:`search` + +.. _oslo: https://wiki.openstack.org/wiki/Oslo diff --git a/doc/source/readme.rst b/doc/source/readme.rst deleted file mode 100644 index a6210d3..0000000 --- a/doc/source/readme.rst +++ /dev/null @@ -1 +0,0 @@ -.. include:: ../../README.rst |