
The :doc: role is only known to Sphinx, so when we publish the README.rst to PyPI and include that role it causes the content to not render as proper HTML. This patch removes some of the content from the readme and moves it to the main index page for the documentation. It then removes the readme.rst file from the doc build because we don't need to include the same content multiple times. Change-Id: Ic46c7a9d8e91f01b5e6cef5d377a56856b586c70 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
22 lines
869 B
ReStructuredText
22 lines
869 B
ReStructuredText
=======================
|
|
python-storyboardclient
|
|
=======================
|
|
|
|
Python Client library for StoryBoard
|
|
|
|
This is the StoryBoard python client! It lets you interact with
|
|
StoryBoard from the comfort of your own terminal! There is no
|
|
command to run this; instead you can import it into scripts. This
|
|
lets you perform complex actions on things in StoryBoard, eg: add an
|
|
helpful comment on all stories with 'cannot store contact information'
|
|
in the description, pointing users at the relevant docs, but only
|
|
if there is no comment to this effect already. (There is an example
|
|
of such a script in the documentation.)
|
|
|
|
Happy task-tracking!
|
|
|
|
* Free software: Apache license
|
|
* Documentation: http://docs.openstack.org/infra/storyboard/
|
|
* Source: http://git.openstack.org/cgit/openstack-infra/python-storyboardclient
|
|
* Bugs: https://storyboard.openstack.org/#!/project/755
|