Commit Graph

5 Commits

Author SHA1 Message Date
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
Zara 3decaa7452 Add basic docs for python client
Now a user can more easily find out how to update StoryBoard via the
python client.

Story: 2000710
Task: 3190

Change-Id: Ie59933344c24bca59477d75fa589a063d8866c6f
2016-09-02 11:18:56 +00:00
Elizabeth K. Joseph 1c1c7a7498 Fix link to docs in README
Change-Id: I8a5e29291d66804a12e99e94edab06153be152b0
2016-04-08 09:47:24 -07:00
Zara c0a604b432 Update Docs
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
2016-03-29 17:53:59 +00:00
Nikita Konovalov fabfa59c6e Initial Cookiecutter Commit.
Change-Id: Ia2beb899b752a5db22a5dc12ff55852a7764ac34
2014-12-04 17:10:28 +03:00