opendev/python-storyboardclient
Code Issues Proposed changes

Update Docs

Browse Source 
The installation instructions were incorrect; they advised the user to
install a package via pip that was not registered in pypi. This patch
changes the installation instructions to ones that work. To avoid
confusion, this patch also notes that the client does not run via a
command, but can just be imported into other scripts.

Change-Id: If34a26dc78641daf0be90dab4a7f788dc72db4bb
This commit is contained in:
Zara 2016-03-29 17:53:46 +00:00
parent e31f95e447
commit c0a604b432
2 changed files with 15 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.rst
View File

@ -13,3 +13,9 @@ Features
--------
* TODO
Notes
-----
There is no command to run this; rather it can be imported into other
scripts.

12
doc/source/installation.rst
View File

@ -2,11 +2,17 @@
Installation
============
At the command line::
Clone the repo::
$ pip install python-storyboardclient
$ git clone git://git.openstack.org/openstack-infra/python-storyboardclient
Inside the repo, on the command line::
$ sudo python setup.py install
$ pip install .
Or, if you have virtualenvwrapper installed::
$ mkvirtualenv python-storyboardclient
$ pip install python-storyboardclient
$ sudo python setup.py install
$ pip install .