delta/openstack/python-saharaclient.git/doc, branch stable/stein

Fix build with Sphinx 1.7.x

2018-04-25T13:35:31+00:00

In sphinx 1.7, the sphinx.util.compat.Directive class doesn't exist
anymore, it's available in docutils.parsers.rst.Directive instead,
and it was deprecated in Sphinx 1.6 already. This patch makes it
therefore work in both version 1.6 and 1.7 just by using the new
module path docutils.parsers.rst.Directive.

Change-Id: I2e05c1612c687c029174f045d3ea0fec83e1119a

Updated from global requirements

2018-03-20T14:56:07+00:00

Change-Id: Ie139d509497bce763dcaa4293a0bab7cd806d2af

Follow the new PTI for document build

2018-03-20T09:36:54+00:00

For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I616ad9f7f089873890ba508cf3e39067f046ae53

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