Commit Graph

9 Commits

Author SHA1 Message Date
Mike Perez 9575937e56 Replace support matrix ext with common library
The code to generate a support matrix has been pulled into a common
library. Using this instead of duplicating code in various projects that
need it.

Change-Id: Ib15c086ceb84029e96be0fc60bd64f2a7a3e41aa
Co-Authored-By: Stephen Finucane <stephenfin@redhat.com>
2019-04-16 18:09:14 -07:00
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
xianming mao 408820cbe3 Use ConfigParser instead of SafeConfigParser
The SafeConfigParser class has been renamed to ConfigParser in Python
3.2 [1]. This alias will be removed in future versions.So we can use
ConfigParser directly instead.

[1] http://bugs.python.org/issue10627

Closes-Bug: #1618666
Change-Id: If01186cefad2149d65ffcc1fc6550d72d26f5b11
2016-09-12 16:21:37 +00:00
Dolph Mathews 927b08bbf7 Add token feature support matrix to documentation
This introduces a feature support matrix to illustrate which of our
various token providers supports which API operations and features. This
is intended to mirror Nova's feature support matrix documentation page,
found here:

  http://docs.openstack.org/developer/nova/support-matrix.html

After running `tox -e docs`, the result is embedded in
`doc/build/html/configuration.html`.

Change-Id: I3dc896a2906e25827a9e01afc7de5a737831c336
2016-07-28 15:44:28 +00:00
David Stanek 6f98a9e2bd Removes temporary fix for doc generation
A temporary fix was added to get around a bug in how pbr handles
its autodoc_tree_index_modules setting. Since this bug is fixed we no
longer need the work around.

Change-Id: I6af0fdd6d1efacb47692b89c329e45ac59fef7cb
Closes-Bug: #1260495
2015-05-13 12:01:16 +00:00
Eric Guo 263b27f2cd Remove vim header
We don't need vim modelines in each source file, it can be set in
user's vimrc.

Change-Id: Ie51ad62946afdf39eadcd59edaf8134ec10265c6
Closes-Bug: #1229324
2014-02-08 23:54:04 +08:00
Eric Guo e8f104ad85 Fix typos in documents and comments
Fix typos detected by toolkit misspellings.

* pip install misspellings
* git ls-files | grep -v locale | misspellings -f -

Change-Id: If986f8cfefae08089caa567618dbb13bff0d62d2
2014-01-23 16:24:45 +08:00
Wu Wenxiang ba19d9c295 Remove unused imports
Remove unused imports in doc/ext/apidoc.py

Change-Id: I379ab62564631e7c5a9b616b6eabcc6b4d9e966c
Closes-Bug: #1265332
2014-01-03 08:10:59 +08:00
David Stanek 3f27b309f0 Fixes documentation building
- Adds the ability to build docs using tox
 - Fixes autodoc generation

A Sphinx extension is introduced in the commit to facilitate building
the API documentation. This extension should be removed when
bug 1260495 is fixed.

Change-Id: Ibf5e5403cb7d3e67947c87b2828b64a56a11fc30
2013-12-13 02:47:37 +00:00