8 Commits

Author SHA1 Message Date
Colleen Murphy
c7ab7c5677 Fix doc generation for python 3
1. The html_last_updated_fmt sphinx setting was providing a byte string
   where sphinx expected a str, which produced  warnings (and therefore
   failures):

     WARNING: The config value `html_last_updated_fmt' has type `bytes', expected to ['str'].

   The solution provided is copied from cinder's solution[1].

2. The .keys() method in python 3 returns a dict_keys object rather than
   a list and it does not include a .sort() method. This patch swaps
   .sort() out for the global function sorted() which works in both python
   2 and python 3.

This came up because on some newer distros that don't install python 2
by default, virtualenv defaults to creating a python 3 environment when
none is specified.

[1] https://review.openstack.org/#/c/433081

Change-Id: I68b796fa2e33fd6c3df67b542def31e6ba620944
2017-04-17 07:44:47 +02:00
yuhui_inspur
84789755aa Remove the file encoding which is unnecessary
Basically, the commit removes the file encoding - since jenkins is fine
with it, means it was really unnecessary and the change makes sense.

Change-Id: I0d97104b173b00a383955b5ad5b597e4c6a19780
2017-02-11 01:16:26 +00:00
Eric Brown
30d9095d28 Use https for docs.openstack.org references
The openstack.org pages now support https and our references to
the site should by default be one signed by the organization.

Change-Id: I30a462e03d1fd7852511e22cac34c6bc0e8917f4
2017-01-30 16:05:08 -08:00
Ha Van Tu
fb7be8ccd0 [api-ref] Stop supporting os-api-ref 1.0.0
The os-api-ref 1.0.0 is out. We can remove the support to older version
now.
Reference:
https://github.com/openstack/senlin/commit/
6d41feb58dd836d426c9b6f025846dbbf7295097
https://review.openstack.org/#/c/362170/

Change-Id: Ibdd4547d5cf90b31ddff0b548e649d46286cf70e
2016-09-07 11:55:14 +07:00
Ha Van Tu
2b6d04b77f Config logABug feature for Keystone api-ref
Currently, Keystone api-ref is not configured with logABug feature.
When users click "Report bug" button, it leads to
"bugs.launchpad.net/openstack-manuals" which is default.
We should change it to "bugs.launchpad.net/keystone/"

Change-Id: I8d6fc4d2a6ab9d7f444a02cbc2f756fdaa3de264
2016-08-31 14:15:46 +07:00
Graham Hayes
80888cf344 Get ready for os-api-ref sphinx theme change
Change-Id: I528d91833156b1c4e638dab2a249c3b2871004b4
2016-08-19 16:44:02 +01:00
Steve Martinelli
4f183727f1 generate separate index files for each api-ref
currntly, no index.html file is generated for any of the APIs,
which should be required to migrate over to the api-site.

check the generated build.

Change-Id: Ib290c7412ff426b3061c5ad7535c8cb8310500fa
2016-07-04 13:03:55 -07:00
Samuel de Medeiros Queiroz
9a5395f1b2 Migrate identity /v3 docs from api-ref repo
Docs at [1] have already been converted from WADL (SGML / XML) to RST
using fairy-slipper [2].

This commit polish the results from the conversion and migrate the docs
to our repository under 'api-ref/source' directory. In addition, it
added missing descriptions for access_token_id and consumer_id to
'parameters.yaml'.

Polishing the generated RST files include:
- Removing unnecessary blank lines;
- Removing empty references.

Polishing the generated RST files do not include:
- Modifying their content;
- Modifying file names;
- Wrapping lines at the maximum of 79 chars.

Updating the documentation will be done after this migration step.

This change also adds a tox environment to build the docs using sphinx
under 'api-ref/build', which in turn is added to '.gitignore'.

Lastly, 'os-api-ref' is added as a test requirement. It provides the
sphinx stanzas rest_method and rest_parameter, used to define OpenStack
APIs in RST docs.

[1] https://github.com/openstack/api-site/tree/master/api-ref/source/identity/v3
[2] https://github.com/russell/fairy-slipper

Change-Id: If1b9a3e1b2e4ea7211c337071254c26b881893a3
2016-05-24 09:58:23 -03:00