openstack/deb-python-happybase
Code Issues Proposed changes

Add some links to the README file

Browse Source
This commit is contained in:
Wouter Bolsterlee
2012-06-05 21:58:37 +02:00
parent fe11c9a390
commit 747f01846c
1 changed files with 9 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.rst
View File

@@ -5,10 +5,13 @@ HappyBase
**HappyBase** is a developer-friendly `Python <http://python.org/>`_ library to
interact with `Apache HBase <http://hbase.apache.org/>`_.
The source code is available from https://github.com/wbolster/happybase.
External links:
Documentation for HappyBase is in the `doc/` directory. Run `make doc` to
generate the HTML documentation, then browse to `doc/build/html/index.html`.
Alternatively, you can view the docs online at
http://happybase.readthedocs.org/, but keep in mind that this may be an
outdated version.
* `Documentation <http://happybase.readthedocs.org/>`_ (readthedocs.org)
* `Downloads <http://pypi.python.org/pypi/happybase/>`_ (PyPI)
* `Source code <https://github.com/wbolster/happybase>`_ (Github)
.. If you're reading this from the README.rst file in a source tree,
you can generate the HTML documentation by running "make doc" and browsing
to doc/build/html/index.html to see the result.