In 7828bed0febabfa11a0a8f6960f4c7cc8acec841 we were introduced
python-binary-memcached in requirement, and we need these
package to support sasl protocol, so we should bump
python-binary-memcached>=0.29.0 in oslo.cache requirements.
Only required for sasl/binary protocol
Co-Authored-By: Brin Zhang <zhangbailin@inspur.com>
Change-Id: Ic4335f0a81c6189d6d0ad254c4a1bb86dbd11500
Implements: blueprint enable-sasl-protocol
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems
Update Sphinx version as well.
openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.
Set openstackdocs_auto_name to use project as name.
Fix wrong indent in index.rst that lead to a grey bar on the left of the
toc.
Depends-On: https://review.opendev.org/728938
Change-Id: If82be6fbfb12cedd8f9dcfb4468415e085d1c821
Enable warnings as errors for docs building, fix building of docs.
Use newer TOX_CONSTRAINTS instead of obsolete UPPER_CONSTRAINTS file.
Change-Id: Id3ec68ab35727a28e60fa51a343057240fe62b31
Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.
[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045
Change-Id: I91ed3b79467683cfca34ef7d79afeb3e6d966f86
Bandit 1.6.0 accidentally changed how the exclusion list option is
handled and breaks our use of it. Cap to the previous version until
Bandit has fixed the problem.
Sphinx 2.0 no longer works on python 2.7, so we need to start capping
it there as well.
Change-Id: I4ee88377e7123c165434765a73f27cabec8c8177
Reference: https://github.com/PyCQA/bandit/pull/489
We do not need tox_install.sh, pip can handle constraints itself
and install the project correctly. Thus update tox.ini and remove
the now obsolete tools/tox_install.sh file.
This follows https://review.openstack.org/#/c/508061 to remove
tools/tox_install.sh.
Change-Id: I48f31084d595c44114391e046e5fe418c1fb787a
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
Changes doc jobs to not user the pbr autodoc_tree_index_modules
directive to generate module documentation by using the new
sphinxcontrib.apidoc extension.
Depends-On: https://review.openstack.org/560379/
Change-Id: Idc84455cf78b6114b31109b7ef9ab3ac9c97e136
The usage example of cache.configure_cache_region was missing
one input parameter, CONF.
TrivialFix
Change-Id: I43427fac6da2f4399d574ce762b40967d414fdda
Add automatically generated documentation for the configuration options
using oslo_config.sphinxext.
Change-Id: Ic8372b14cf5bbe423d098f4bb9cf4536c9336c2f
All changes are based on comments
from Ie3e6c8a3671bc28bfd6967e8758c1419c3c8d501
TrivialFix
Co-Authored-By: Pavel Kholkin <pkholkin@mirantis.com>
Change-Id: I2fb44c736d3c15edab5c41ba99e73daed38f7258
This backend is based on dictionary and memorycache client from
https://github.com/openstack/oslo-incubator/blob/master/openstack/common/memorycache.py
This backend was implemented to be used in Nova
because there is no appropriate default backend in dogpile.
Co-Authored-By: Pavel Kholkin <pkholkin@mirantis.com>
Change-Id: Ie3e6c8a3671bc28bfd6967e8758c1419c3c8d501
The backends need to be in the documentation so that developers know
what the options are.
Change-Id: If426c95a39424232ccda2d543bdaac3844ed61a8
Partial-Bug: 1469831
Partial-Bug: 1469833
The public modules weren't referenced anywhere so the
auto-generated module docs weren't generated.
Partial-Bug: 1469831
Change-Id: Ic4eaf1fc809d084f79ed9efc494830c5dca3a2cf