diff options
| author | Joshua Harlow <harlowja@yahoo-inc.com> | 2014-12-18 13:19:30 -0800 |
|---|---|---|
| committer | Joshua Harlow <harlowja@yahoo-inc.com> | 2014-12-18 13:19:30 -0800 |
| commit | 4c2996525f96fc7ab93fe787b470d82da6561c19 (patch) | |
| tree | 493174032c1e1eb87e6b006c7b4536e73cbcbe7f | |
| parent | 80162be3db9060834f6ff4aa3a2b749208e2ec3f (diff) | |
| download | tooz-4c2996525f96fc7ab93fe787b470d82da6561c19.tar.gz | |
A few more documentation tweaks
- 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
| -rw-r--r-- | doc/source/index.rst | 13 | ||||
| -rw-r--r-- | doc/source/install.rst | 6 |
2 files changed, 13 insertions, 6 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index c82afed..f88bdfb 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 like group membership protocol, lock service and leader election by providing -a coordination API helping developers to build distributed applications. -Contents: +a coordination API helping developers to build distributed applications. [#f1]_ + +Contents +======== .. toctree:: :glob: @@ -21,3 +23,8 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :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. diff --git a/doc/source/install.rst b/doc/source/install.rst index 5592414..3070b4a 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -5,14 +5,14 @@ Installation Python Versions =============== -tooz is tested under Python 2.7 and 3.4. +Tooz is tested under Python 2.7 and 3.4. .. _install-basic: 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 global site-packages). You may need administrative privileges to do that. The easiest way to install it is using pip_:: @@ -28,7 +28,7 @@ or:: 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 Source Code |