openstack/deb-python-tooz
Code Issues Proposed changes

A few more documentation tweaks

Browse Source 
- Capitalize tooz where appropriate.
- Adjust contents to be an actual header.
- Add a footnote that states tooz can be generally useful
  for anyone (and not just openstack projects); this was taken
  from taskflows similar footnote.

Change-Id: I9b4e0304483e2c7155f4d5107fd2967ed2c8d1a4
This commit is contained in:
Joshua Harlow
2014-12-18 13:19:30 -08:00
parent 80162be3db
commit 4c2996525f
2 changed files with 13 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/source/index.rst
View File

@@ -1,11 +1,13 @@
============================================================= =============================================================
tooz -- Distributed System Helper Library Tooz -- Distributed System Helper Library
============================================================= =============================================================
The Tooz project aims at centralizing the most common distributed primitives The Tooz project aims at centralizing the most common distributed primitives
like group membership protocol, lock service and leader election by providing like group membership protocol, lock service and leader election by providing
a coordination API helping developers to build distributed applications. a coordination API helping developers to build distributed applications. [#f1]_
Contents:
Contents
========
.. toctree:: .. toctree::
:glob: :glob:
@@ -21,3 +23,8 @@ Indices and tables
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex` * :ref:`modindex`
* :ref:`search` * :ref:`search`
.. [#f1] It should be noted that even though it is designed with OpenStack
integration in mind, and that is where most of its *current*
integration is it aims to be generally usable and useful in any
project.

6
doc/source/install.rst
View File

@@ -5,14 +5,14 @@ Installation
Python Versions Python Versions
=============== ===============
tooz is tested under Python 2.7 and 3.4. Tooz is tested under Python 2.7 and 3.4.
.. _install-basic: .. _install-basic:
Basic Installation Basic Installation
================== ==================
tooz should be installed into the same site-packages area where Tooz should be installed into the same site-packages area where
the application and extensions are installed (either a virtualenv or the application and extensions are installed (either a virtualenv or
the global site-packages). You may need administrative privileges to the global site-packages). You may need administrative privileges to
do that. The easiest way to install it is using pip_:: do that. The easiest way to install it is using pip_::
@@ -28,7 +28,7 @@ or::
Download Download
======== ========
tooz releases are hosted on PyPI and can be downloaded from: Tooz releases are hosted on PyPI and can be downloaded from:
http://pypi.python.org/pypi/tooz http://pypi.python.org/pypi/tooz
Source Code Source Code