summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoshua Harlow <harlowja@gmail.com>2015-04-07 09:17:26 -0700
committerJoshua Harlow <harlowja@yahoo-inc.com>2015-04-07 14:47:07 -0700
commit198a9e7cf70604552e23b5a262f9fc261298ce83 (patch)
treed94a4270d81259c06d4adec5fc33f82b58712796 /doc
parentf749ad436288841f9df5af284966b2b1c639e428 (diff)
downloadoslo-db-198a9e7cf70604552e23b5a262f9fc261298ce83.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: Idb17dd30403daa130176643f4609fdd7c61c076e
Diffstat (limited to 'doc')
-rw-r--r--doc/source/index.rst24
1 files changed, 15 insertions, 9 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 5e96766..2be70dd 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,25 +1,31 @@
-=========
- oslo.db
-=========
+===================================
+Welcome to oslo.db's documentation!
+===================================
-The Oslo database handling library. Provides database connectivity
-to the different backends and helper utils.
-
-Contents
---------
+The `oslo`_ db (database) handling library, it provides database connectivity
+to different database backends and various other helper utils.
.. toctree::
:maxdepth: 2
installation
usage
- api/index
contributing
history
+API Documentation
+=================
+
+.. toctree::
+ :maxdepth: 2
+
+ api/index
+
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
+
+.. _oslo: https://wiki.openstack.org/wiki/Oslo