delta/openstack/python-saharaclient.git/doc/source, branch 2.2.1

Migration to Storyboard

2018-03-17T13:25:54+00:00

Sahara projects migrated to storyboard.openstack.org.
Replace the references to Launchpad and clean up some duplication.
Fix the bug link in the openstackdocstheme configuration.

Change-Id: I01092ad6d35e2c0624646033d95c00526094a06d

Auto-document members properly

2018-01-26T18:02:47+00:00

Supporting APIv2 in saharaclient meant that there is now some fancier
inheritance going on, so Sphinx :members: now misses a bunch of
user-facing methods. Now, start using :inherited-members: to get what
we want.

Additionally, put the v2 docs under the main reference section instead
of in their own section.

Change-Id: I56067fe54332497f8d0962986383b74a27d84a76
Closes-Bug: #1745650

APIv2 support in client

2018-01-25T05:47:33+00:00

* Support of all APIv2 features carried from APIv1 ("feature parity")
* Minimum amount of docs to pass the gate
* Endpoint manipulation and version discovery handled by keystoneauth
* APIv2 feature: decommision of specific instances (doc change only)
* APIv2 feature: force delete (new method)

Unit tests will arrive in a future patch.

bp v2-api-experimental-impl

Co-Authored-By: Monty Taylor 
Change-Id: I32178439fe85cc6d5faf4ac2e33ae80c08619de5

Reorganize the documentation following the new structure

2017-09-04T16:43:22+00:00

- move api as "reference" guide and reword as Python client;
- consolidate shell and cli as part of the "CLI" guide;
- remove the "how_to_participate" page and use part of
  the content from the old index for a minimal "contributor"
  guide which redirect to the sahara contributor guide
  (no need to duplicate the information);
- remove few references to doc/source/api from tox.ini and
  .gitignore (for some reason the directory was cleaned).

Change-Id: Iff049ab32a7695a7a58bd370a1517b1ed7d2f048

Update and optimize documentation links

2017-07-18T08:06:56+00:00

1. Update URLs according to document migration
2. Update the dead links
3. Optimize (e.g. http -> https)

Change-Id: Ib66107d24a5171676a73cde7ead487bef259a5d5

doc: migrate to openstackdocstheme

2017-07-13T17:09:43+00:00

Both doc/ and releasenotes/
Change-Id: Ic9a5d593053364e8b10f022b53cb0ab2587431b0

doc: enable warning-is-error and fix warnings

2017-07-13T16:51:45+00:00

A small workaround is required for a specific parameter (see the
inline comment).

Change-Id: I1eac60cc8ca89a12dd568f5a12f70fdab9b76b62

Fix html_last_updated_fmt for Python3

2017-06-04T09:46:19+00:00

html_last_updated_fmt option is interpreted as a
byte string in python3, causing Sphinx build to break.
This patch makes it utf-8 string.

Change-Id: I9b23a0dfadaa195bc22ee7f8b8da0c0c9a0e6052
Closes-Bug:#1693670

Fix doc build if git is absent

2016-08-31T14:01:53+00:00

When building packages if git is absent, then we should not set
html_last_updated_fmt. It can still be set via the -D switch
when building with sphinx-build.

Change-Id: Ie6477df7f65e5035b1b03b51f698972ce9dd9aaa
Closes-Bug: #1552251

Remove unused pngmath Sphinx extension

2016-02-29T18:58:37+00:00

There's no RST file that uses ".. math" and thus
the pngmath Sphinx extension is not used and can
get removed.

Change-Id: I3ea4b529025c8ac3c4092f3720124647861e6668