autodoc_default_flags was deprecated and is now triggering a warning
that breaks our builds. Switch to the equivalent autodoc_default_options
configuration, which essentially turns the flags into dict keys that
map to None[1]: 'Setting None is equivalent to giving the option name
in the list format (i.e. it means “yes/true/on”).'
Change-Id: I573f19a054e535a90db8bb16a02b2c7f28d8e6d1
1: http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_default_options
We want to default to running all tox environments under python 3, so
set the basepython value in each environment.
We do not want to specify a minor version number, because we do not
want to have to update the file every time we upgrade python.
We do not want to set the override once in testenv, because that
breaks the more specific versions used in default environments like
py35 and py36.
Decode the output of subprocess in doc/source/conf.py so that we always
have a string.
Change-Id: I17601d56b6e6d9d300bb07d8982a7bbde637822e
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Fix doc building with new PTI changes and job updates.
Add a doc/requirements.txt file with all needed dependencies.
Change-Id: Ic7963520aeb0b9c463c4f9b5675589308720d6f8
list-table is easier to be maintained.
In addition, we avoid too long lines.
We no longer have too long lines which doc8 complains,
so doc8 ignore_path can be dropped.
Change-Id: I574391295288ef9e33744aa608c2f2930a6e46f8
- Update sphinx so that warning-is-error option is available
- Fix sphinx warnings
- Install python modules required for automodule into docs env
- Fix docstring warning in tooz/coordination.py
- pbr warnerrors is no longer needed in favor of sphinx warning-is-error
Change-Id: I5d54c452522b6ee00884d7d17105af22b4c95189
Add a new object called `Partitioner' which is based on the consistent
hashring implementation of tooz.hashring. The coordinator API allows to
create such an object and to use it to dispatch objects ownership across
several workers.
Change-Id: Iae8c861d5b6c15b714f1ec3bd7090d15dd468421
This is a consistent hash ring implementation based on the one that can
be found in Nova, Ironic, Ceilometer and Aodh.
Change-Id: I5d2f4efcd354a187747fa645482db2029a1a14b7
Start to organize this page with a more helpful structure
that will allow people to read it and figure out which driver
best fits there usage (and to help people decide which ones
don't).
Change-Id: I871d2eb7e7493a6633f7738ff063042d39690364
Since we run 2.6 CI tests (and the setup.cfg
classifiers so we support 2.6); we might as well mention
this in the docs.
Change-Id: I9b59378f717f7df280c429a53d0a83c129327481
Multiple sentinel hosts are now allowed by listing the additional
hosts as multiple 'sentinel_fallback' parameters. These are combined
with the first sentinel host to create a list that is provided to
Sentinel class constructor.
This provides safety in the case when the first (or any other) sentinel
host goes down.
Tests are run twice: once with fallbacks, once without.
Change-Id: Ie0a134f02617e8552a87c8bcd49996daaba07f4e
If sentinel support is desired then the connection URI should take
the form:
redis://<sentinel host>:<sentinel port>?sentinel=<master name>
This will be parsed to connect to a Sentinel server to discover a
master. The response will be used to make a connection to the
current master.
The setup-sentinel-env.sh script will exit with an error if either
the redis-server or sentinel cannot be found. When the script is
done it will clean up the mess it makes.
Change-Id: I205ed88c72587d9f5f916d344c44192bee2aa41a
- Capitalize tooz where appropriate.
- Adjust contents to be an actual header.
- Add a footnote that states tooz can be generally useful
for anyone (and not just openstack projects); this was taken
from taskflows similar footnote.
Change-Id: I9b4e0304483e2c7155f4d5107fd2967ed2c8d1a4
Start to add/build a developer oriented doc that
can be further refined to explain to developers how
to use the different tooz drivers (and what the varying
drivers capabilities are).
Change-Id: I49f6bf5b397d6bc5426c074f6196c764c8938d23
Adjust the docs to generate in the common OpenStack
format using the common OpenStack theme.
Also adjust the copyright to now be the 'OpenStack
Foundation' instead of being 'eNovance' now that
this code is under the openstack repositories.
Change-Id: I4026e80a1c98a8052d306d104bc92c70a3a36c3e
To ensure the docs are style checked add in doc8 to the
py27 tox environment so that the docs will be checked.
This also adjusts the one issue that was found in one
of the rst files.
Change-Id: Iea38d4ac53d9c5255e0694a840c38b04530890ce
Some code in the drivers might actually raise the standard
NotImplemented error, and that would be a bug to skip a test if that was
the case. In that case we want the test to fail.
So let's switch to a custom exception that is used to skip the test if
it's raised.
Change-Id: Ideafee0b1f008ff32724fb98d6a477bd3976104d
