Commit Graph

10 Commits

Author SHA1 Message Date
Ian Wienand 0ae49a0017 Replace openstack.org git:// URLs with https://
This is a mechanically generated change to replace openstack.org
git:// URLs with https:// equivalents.

This is in aid of a planned future move of the git hosting
infrastructure to a self-hosted instance of gitea (https://gitea.io),
which does not support the git wire protocol at this stage.

This update should result in no functional change.

For more information see the thread at

 http://lists.openstack.org/pipermail/openstack-discuss/2019-March/003825.html

Change-Id: Ibde64f2c93bebb429c7d687ef27e107aaae671a5
2019-03-24 20:35:57 +00:00
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
Doug Hellmann ef985c01c3 update documentation build for new PTI
Move documentation dependencies to doc/requirements.txt.

Update tox.ini to run the documentation build the same way the zuul
job does.

Switch from oslosphinx, which is deprecated, to openstackdocstheme.

Change-Id: I6ec358fecefcc6f88f498cf12cd45b77989f5c26
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2018-01-12 16:06:57 -05:00
Andreas Jaeger 9df1719ff1 Remove link to modindex
The documentation build does not generate any module index, thus remove
the link to the page. The page
http://docs.openstack.org/infra/python-storyboardclient/py-modindex.html
does not exist.

Change-Id: I008c16988638a44cde54295e24dc396207c234d2
2016-12-28 16:37:34 +01:00
Zara d7622a8f0a Update 'usage'
This updates the commentary on the python client, now that it can
work with StoryBoard instances that use self-signed certificates.

It also removes 'examples of delete commands' from the TODOs, as
we don't want to make it easy for passers-by to copy-paste a command to
delete data in bulk without any understanding.

Change-Id: Icb9660ac79992a1e53baa89f1016c626b0cfe467
2016-09-23 17:58:57 +00:00
Zara 1b0c01e7b7 Note importance of using https url instead of http
Otherwise, the user will get this error:

`AttributeError: 'list' object has no attribute 'iteritems'`

which is rather difficult to track down.

Change-Id: I49f69bb34e38f7dda0e37fad7f50f11c07b71880
2016-09-05 15:18:01 +00:00
Andreas Jaeger 3695e1f312 It's 2016
Update copyright year.

Change-Id: I999db0ce19886f443420c9b566771a4fb5292ab6
2016-09-05 12:20:00 +02: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
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