opendev/python-storyboardclient
Code Issues Proposed changes
Python Client library for StoryBoard
75 Commits 1 Branch 2 Tags 657 KiB
Python 99.9%
reStructuredText 0.1%
af25ae6e07
Go to file
Doug Hellmann af25ae6e07 remove sphinx-isms from README.rst and clean up docs 
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>
2018-04-12 21:18:39 +00:00
doc remove sphinx-isms from README.rst and clean up docs 2018-04-12 21:18:39 +00:00
storyboardclient use six to make iteritems python 2/3 compatible 2018-01-24 17:20:36 -05:00
.coveragerc remove or adopt incubated oslo code 2016-11-08 13:44:49 -05:00
.gitignore ignore .stestr output directory 2018-01-24 17:20:28 -05:00
.gitreview Added .gitreview 2014-12-01 09:51:21 +00:00
.mailmap Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
.testr.conf Setting up base classes 2014-12-22 16:36:08 +03:00
babel.cfg Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
CONTRIBUTING.rst fix formatting of contributing file 2018-01-12 16:07:01 -05:00
HACKING.rst Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
LICENSE Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
MANIFEST.in Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
README.rst remove sphinx-isms from README.rst and clean up docs 2018-04-12 21:18:39 +00:00
requirements.txt remove or adopt incubated oslo code 2016-11-08 13:44:49 -05:00
setup.cfg build universal wheels 2018-02-16 15:19:15 -05:00
setup.py Initial Cookiecutter Commit. 2014-12-04 17:10:28 +03:00
test-requirements.txt update documentation build for new PTI 2018-01-12 16:06:57 -05:00
tox.ini Merge "change default python 3 env in tox to 3.5" 2018-02-11 15:30:28 +00:00

README.rst

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!