Commit Graph

35 Commits

Author SHA1 Message Date
songwenping 2d610d0abc Remove unnecessary unicode prefixes
All strings are unicode by default in Python 3. No need to mark them as such.

Change-Id: If2b75ca342bf613d9c1bc3f34f6afcf51a22d640
2022-04-19 15:07:53 +08:00
Hervé Beraud f4fa6aa6fa Add socket keepalive options to oslo.cache
This patch specifies a set of options required to setup the
socket keepalive of the dogpile.cache's pymemcache
backend [1][2]. This setup from those options can later on
be passed to this backend.

This patch also sets up the socket keepalive object based on
the configuration options passed via oslo.config and adds it
as an argument to be passed to the selected oslo.cache backend.

Dogpile.cache will be used as an interface between oslo.cache and
pymemcache [3].

[1] https://github.com/sqlalchemy/dogpile.cache/pull/205
[2]
b289c87bb8
[3]
https://dogpilecache.sqlalchemy.org/en/latest/api.html?highlight=keepalive#dogpile.cache.backends.memcached.PyMemcacheBackend.params.socket_keepalive

Change-Id: I501100e1a48cdd4e094c08046e2150405dcf371e
2022-01-07 11:58:28 +01:00
dengzhaosen c872fc0b94 Add python-binary-memcached to support SASL
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
2020-08-19 13:53:31 +00:00
Moisés Guimarães de Medeiros 1717811456 Apply fixes for pre-commit compliance in all code
conf.py fails pre-commit hook id: check-executables-have-shebangs
solution: chmod -x doc/source/conf.py

Change-Id: Ie9e8a13709666516416d3893b2da9059d9372ef1
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
2020-07-29 11:16:29 +02:00
melissaml 18e76738e7 Fix pygments style
New theme of docs respects pygments_style.

more info: http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I48e1636ea38c51aa71ca60fcf8387b7a0c9c4d8e
2020-06-04 14:26:08 +08:00
Andreas Jaeger 49b4d42c58 Switch to newer openstackdocstheme and reno versions
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
2020-05-18 21:08:45 +02:00
Andreas Jaeger ddd9807fe1 Small cleanups in tox.ini
Enable warnings as errors for docs building, fix building of docs.

Use newer TOX_CONSTRAINTS instead of obsolete UPPER_CONSTRAINTS file.

Change-Id: Id3ec68ab35727a28e60fa51a343057240fe62b31
2020-05-09 14:42:28 +02:00
Hervé Beraud 0c741b71f6 Add release notes links to doc index
Change-Id: I67d25a53ef11fc8837241deba192c2ced4669617
2020-04-16 15:52:05 +02:00
Hervé Beraud aa2a5c21eb Fix python2 syntaxe in doc
Change-Id: I07555b658f3730851baaa0772b2567f1f23bcab6
2020-03-05 17:38:09 +01:00
Andreas Jaeger 791b9952d5 [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Change-Id: Ie8e737cfde8b2587ef60cd25ab746e6b04936390
2020-02-03 13:44:20 +01:00
caoyuan 29098ac5f1 tox: Keeping going with docs
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
2019-10-24 15:01:16 +08:00
Ben Nemec 3e06753078 Cap Bandit below 1.6.0 and update Sphinx requirement
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
2019-05-13 17:55:09 +00:00
jacky06 fcce95b66f Replace git.openstack.org URLs with opendev.org URLs.
Replace the old url by the new one in the README.rst file. Fix the title
format in several files.

Change-Id: I8777c0b9e09b91ae3ca89d562bf5fa2c24720616
2019-05-09 09:15:16 +02:00
Stephen Finucane 6503e2426e Avoid tox_install.sh for constraints support
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>
2019-05-04 07:02:41 +02:00
Sean McGinnis 6507ff752e Avoid use of autodoc_tree_index_modules
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
2018-04-12 16:13:14 -04:00
OpenStack Proposal Bot a32bd447fa Updated from global requirements
Change-Id: I5d981113fb3a9ee5360343ab9fb55695bc588e35
2018-03-15 07:46:59 +00:00
OpenStack Proposal Bot 26b9f6963a Updated from global requirements
Change-Id: Ic76ba460a26a52719fabc3a9aaf0a3e542ce38a0
2018-01-24 01:24:39 +00:00
OpenStack Proposal Bot db748471a7 Updated from global requirements
Change-Id: Ie802df38d54eb4331ab91ec5703896c10703f95b
2018-01-18 03:22:48 +00:00
ChangBo Guo(gcb) e52c99825c Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:
https://governance.openstack.org/tc/reference/project-testing-interface.html

For more detials information, please refer to:
http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: I46607ac6b8448f6f6373736e54f5f75fa626538f
2018-01-04 13:16:33 +08:00
Dong Ma 66a72a1bc7 turn on warning-is-error in doc build
Change-Id: Iad1ac75bfe1a29350d23014f0b7345d3e8f76c41
2017-07-07 00:10:38 +08:00
Dong Ma a190e51574 switch from oslosphinx to openstackdocstheme
Change-Id: I67f62da5b2b3cc89367cdcf731aa33c8161c1f2f
2017-07-06 23:57:57 +08:00
Dong Ma a2335dbb69 rearrange content to fit the new standard layout
Change-Id: I5cbe836cf54f752eb4f93e105ffb49b387440db7
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
2017-07-06 23:45:16 +08:00
Rodolfo Alonso Hernandez 6a4e6df734 Fix error in cache.configure_cache_region usage doc
The usage example of cache.configure_cache_region was missing
one input parameter, CONF.

TrivialFix

Change-Id: I43427fac6da2f4399d574ce762b40967d414fdda
2017-06-29 13:24:31 +01:00
Jenkins fed5068270 Merge "Add usage example to documentation" 2016-10-14 13:21:28 +00:00
George Silvis, III 92a979b689 Add usage example to documentation
This example is cobbled together from Keystone's use-case.

Change-Id: Ib0ab0926f2cc86e2b45dfccbf8f73c638ec90a6f
2016-08-20 09:37:46 -04:00
Andreas Jaeger 1129b5245b Fix OpenStack capitalization
Small documentation nit:
s/Openstack/OpenStack/g

Change-Id: Ibab1cae72b9396dc1c45f063810a960e98538522
2016-07-28 09:19:28 +02:00
Jamie Lennox a7709f65c1 Fixup intersphinx docs
Setup intersphinx in doc building and correct doc links to oslo.config
and dogpile.cache.

Change-Id: I2f6daded5ee8ddafce03b5165d386b1349dc107e
2016-06-09 17:40:33 +10:00
Joshua Harlow 140f337779 add auto-generated docs for config options
Add automatically generated documentation for the configuration options
using oslo_config.sphinxext.

Change-Id: Ic8372b14cf5bbe423d098f4bb9cf4536c9336c2f
2015-09-24 12:33:52 -07:00
Brant Knudson 6569f726a3 Fixes up the API docs and module index
- Automatically generate the API docs
- Makes the index on the modules index page useful

Change-Id: I4eafe2c64a0733f6fb81b20e85cd943355860f9a
2015-07-09 18:22:58 -05:00
Sergey Nikitin de4b2848e0 Changed some comments and docs in DictCacheBackend
All changes are based on comments
from Ie3e6c8a3671bc28bfd6967e8758c1419c3c8d501

TrivialFix

Co-Authored-By: Pavel Kholkin <pkholkin@mirantis.com>

Change-Id: I2fb44c736d3c15edab5c41ba99e73daed38f7258
2015-07-08 11:00:02 +03:00
Sergey Nikitin 4b0cac8fb6 Implemented DictCacheBackend
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
2015-07-07 15:50:31 +03:00
Pavel Kholkin e4c7731a78 Fixed typos
TrivialFix

Change-Id: Id8cea90ee4bdfa2d596fd94d6b2da01f81265811
2015-07-06 15:22:17 +03:00
Brant Knudson 86f016f75e Document the backends
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
2015-07-01 13:51:05 -05:00
Brant Knudson 448c69157c Module docs
The public modules weren't referenced anywhere so the
auto-generated module docs weren't generated.

Partial-Bug: 1469831
Change-Id: Ic4eaf1fc809d084f79ed9efc494830c5dca3a2cf
2015-06-29 18:28:53 +00:00
Eric Larson 9b41e58819 Initial commit from oslo cookiecutter template 2015-04-15 11:22:01 -05:00