summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJoshua Harlow <harlowja@gmail.com>2015-04-07 09:16:21 -0700
committerJoshua Harlow <harlowja@yahoo-inc.com>2015-04-07 21:09:17 +0000
commitd04cf66a06789fc6f7c76aabcdcc3bb5f35916fa (patch)
tree3feab0517aa40265f841a4a214e059841677f1ef /doc
parentfe84d2a4ab062173a3cd0de9a7df473a6dd42c12 (diff)
downloadoslo-concurrency-d04cf66a06789fc6f7c76aabcdcc3bb5f35916fa.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: I7b048bc4425197f87436281dd5e46619390c3f43
Diffstat (limited to 'doc')
-rw-r--r--doc/source/index.rst16
-rw-r--r--doc/source/readme.rst1
2 files changed, 8 insertions, 9 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 8d1757f..9619d10 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -1,16 +1,14 @@
-.. oslo.concurrency documentation master file, created by
- sphinx-quickstart on Tue Jul 9 22:26:36 2013.
- You can adapt this file completely to your liking, but it should at least
- contain the root `toctree` directive.
+============================================
+Welcome to oslo.concurrency's documentation!
+============================================
-==================
- oslo.concurrency
-==================
+The `oslo`_ concurrency library has utilities for safely running multi-thread,
+multi-process applications using locking mechanisms and for running
+external processes.
.. toctree::
:maxdepth: 1
- readme
installation
usage
contributing
@@ -30,3 +28,5 @@ 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