summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat
-rw-r--r--CONTRIBUTING.rst4
-rw-r--r--README.rst2
-rw-r--r--ceilometerclient/client.py2
-rw-r--r--ceilometerclient/i18n.py2
-rwxr-xr-xceilometerclient/tests/functional/hooks/post_test_hook.sh6
-rw-r--r--ceilometerclient/tests/unit/v2/test_event_types.py4
-rw-r--r--ceilometerclient/v2/event_types.py4
-rw-r--r--ceilometerclient/v2/samples.py4
-rw-r--r--doc/source/api.rst2
-rw-r--r--doc/source/conf.py11
-rw-r--r--doc/source/index.rst4
-rw-r--r--doc/source/shell.rst2
-rw-r--r--releasenotes/source/conf.py10
-rw-r--r--releasenotes/source/index.rst1
-rw-r--r--releasenotes/source/pike.rst6
-rw-r--r--setup.cfg2
-rw-r--r--test-requirements.txt4
17 files changed, 46 insertions, 24 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 6967cbd..b5abcbd 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -1,13 +1,13 @@
If you would like to contribute to the development of OpenStack,
you must follow the steps documented at:
- http://docs.openstack.org/infra/manual/developers.html#development-workflow
+ https://docs.openstack.org/infra/manual/developers.html#development-workflow
Once those steps have been completed, changes to OpenStack
should be submitted for review via the Gerrit tool, following
the workflow documented at:
- http://docs.openstack.org/infra/manual/developers.html#development-workflow
+ https://docs.openstack.org/infra/manual/developers.html#development-workflow
Pull requests submitted through GitHub will be ignored.
diff --git a/README.rst b/README.rst
index fdb7fc7..d1dccd5 100644
--- a/README.rst
+++ b/README.rst
@@ -21,7 +21,7 @@ provides a Python API (the ``ceilometerclient`` module) and a command-line tool
* `Source`_
.. _PyPi: https://pypi.python.org/pypi/python-ceilometerclient
-.. _Online Documentation: http://docs.openstack.org/developer/python-ceilometerclient
+.. _Online Documentation: https://docs.openstack.org/python-ceilometerclient/latest/
.. _Launchpad project: https://launchpad.net/python-ceilometerclient
.. _Blueprints: https://blueprints.launchpad.net/python-ceilometerclient
.. _Bugs: https://bugs.launchpad.net/python-ceilometerclient
diff --git a/ceilometerclient/client.py b/ceilometerclient/client.py
index 8673e70..2c61f34 100644
--- a/ceilometerclient/client.py
+++ b/ceilometerclient/client.py
@@ -324,7 +324,7 @@ def get_client(version, **kwargs):
:param version: the API version to use ('1' or '2')
:param kwargs: keyword args containing credentials, either:
- * session: a keystoneauth/keystoneclient session object
+ * session: a keystoneauth session object
* service_type: The default service_type for URL discovery
* service_name: The default service_name for URL discovery
* interface: The default interface for URL discovery
diff --git a/ceilometerclient/i18n.py b/ceilometerclient/i18n.py
index 26861e3..a567932 100644
--- a/ceilometerclient/i18n.py
+++ b/ceilometerclient/i18n.py
@@ -14,7 +14,7 @@
"""oslo.i18n integration module.
-See http://docs.openstack.org/developer/oslo.i18n/usage.html .
+See https://docs.openstack.org/oslo.i18n/latest/user/usage.html.
"""
diff --git a/ceilometerclient/tests/functional/hooks/post_test_hook.sh b/ceilometerclient/tests/functional/hooks/post_test_hook.sh
index fcd704c..385d314 100755
--- a/ceilometerclient/tests/functional/hooks/post_test_hook.sh
+++ b/ceilometerclient/tests/functional/hooks/post_test_hook.sh
@@ -21,7 +21,7 @@ function generate_testr_results {
sudo /usr/os-testr-env/bin/subunit2html $BASE/logs/testrepository.subunit $BASE/logs/testr_results.html
sudo gzip -9 $BASE/logs/testrepository.subunit
sudo gzip -9 $BASE/logs/testr_results.html
- sudo chown jenkins:jenkins $BASE/logs/testrepository.subunit.gz $BASE/logs/testr_results.html.gz
+ sudo chown $USER:$USER $BASE/logs/testrepository.subunit.gz $BASE/logs/testr_results.html.gz
sudo chmod a+r $BASE/logs/testrepository.subunit.gz $BASE/logs/testr_results.html.gz
fi
}
@@ -35,13 +35,13 @@ source openrc admin admin
# Go to the ceilometerclient dir
cd $CEILOMETERCLIENT_DIR
-sudo chown -R jenkins:stack $CEILOMETERCLIENT_DIR
+sudo chown -R $USER:stack $CEILOMETERCLIENT_DIR
# Run tests
echo "Running ceilometerclient functional test suite"
set +e
# Preserve env for OS_ credentials
-sudo -E -H -u jenkins tox -efunctional
+sudo -E -H -u $USER tox -efunctional
EXIT_CODE=$?
set -e
diff --git a/ceilometerclient/tests/unit/v2/test_event_types.py b/ceilometerclient/tests/unit/v2/test_event_types.py
index e5d2037..3bccbae 100644
--- a/ceilometerclient/tests/unit/v2/test_event_types.py
+++ b/ceilometerclient/tests/unit/v2/test_event_types.py
@@ -20,7 +20,7 @@ import ceilometerclient.v2.event_types
fixtures = {
- '/v2/event_types/': {
+ '/v2/event_types': {
'GET': (
{},
['Foo', 'Bar', 'Sna', 'Fu']
@@ -40,7 +40,7 @@ class EventTypesManagerTest(utils.BaseTestCase):
def test_list(self):
event_types = list(self.mgr.list())
expect = [
- 'GET', '/v2/event_types/'
+ 'GET', '/v2/event_types'
]
self.http_client.assert_called(*expect)
self.assertEqual(4, len(event_types))
diff --git a/ceilometerclient/v2/event_types.py b/ceilometerclient/v2/event_types.py
index 631f0b4..0f44931 100644
--- a/ceilometerclient/v2/event_types.py
+++ b/ceilometerclient/v2/event_types.py
@@ -17,7 +17,7 @@ from ceilometerclient.common import base
class EventType(base.Resource):
def __repr__(self):
- return "<Event %s>" % self._info
+ return "<EventType %s>" % self._info
def object_class_str(mgr, value, loaded):
@@ -27,4 +27,4 @@ def object_class_str(mgr, value, loaded):
class EventTypeManager(base.Manager):
def list(self):
- return self._list('/v2/event_types/', obj_class=object_class_str)
+ return self._list('/v2/event_types', obj_class=object_class_str)
diff --git a/ceilometerclient/v2/samples.py b/ceilometerclient/v2/samples.py
index e68a761..8752a0d 100644
--- a/ceilometerclient/v2/samples.py
+++ b/ceilometerclient/v2/samples.py
@@ -30,7 +30,7 @@ class OldSample(base.Resource):
"""Represents API v2 OldSample object.
Model definition:
- http://docs.openstack.org/developer/ceilometer/webapi/v2.html#OldSample
+ https://docs.openstack.org/ceilometer/latest/webapi/v2.html#OldSample
"""
def __repr__(self):
return "<OldSample %s>" % self._info
@@ -85,7 +85,7 @@ class Sample(base.Resource):
"""Represents API v2 Sample object.
Model definition:
- http://docs.openstack.org/developer/ceilometer/webapi/v2.html#Sample
+ https://docs.openstack.org/ceilometer/latest/webapi/v2.html#Sample
"""
def __repr__(self):
return "<Sample %s>" % self._info
diff --git a/doc/source/api.rst b/doc/source/api.rst
index b64afe1..df6eaf5 100644
--- a/doc/source/api.rst
+++ b/doc/source/api.rst
@@ -33,7 +33,7 @@ Use queries to narrow your search (more info at `Ceilometer V2 API reference`__)
>>> cclient.new_samples.list(q=query, limit=10)
[<Sample ...>, ...]
-__ http://docs.openstack.org/developer/ceilometer/webapi/v2.html#Query
+__ https://docs.openstack.org/ceilometer/latest/webapi/v2.html#Query
Reference
---------
diff --git a/doc/source/conf.py b/doc/source/conf.py
index bf45db6..00d4a79 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -24,7 +24,7 @@ gen_ref("v2", "Version 2 API Reference",
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinx.ext.autodoc', 'oslosphinx' ]
+extensions = ['sphinx.ext.autodoc', 'openstackdocstheme']
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
@@ -57,6 +57,15 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. Major themes that come with
# Sphinx are currently 'default' and 'sphinxdoc'.
#html_theme = 'nature'
+html_theme = 'openstackdocs'
+
+# openstackdocstheme options
+repository_name = 'openstack/python-ceilometerclient'
+bug_project = 'python-ceilometerclient'
+bug_tag = ''
+
+# Must set this variable to include year, month, day, hours, and minutes.
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
diff --git a/doc/source/index.rst b/doc/source/index.rst
index 82bd8f5..eabd851 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -12,7 +12,7 @@ OpenStack Ceilometer API.
least -- to get an idea of the concepts. By understanding the concepts
this library should make more sense.
- __ http://docs.openstack.org/developer/ceilometer/
+ __ https://docs.openstack.org/ceilometer/latest/
Contents:
@@ -44,7 +44,7 @@ Code is hosted at `git.openstack.org`_. Submit bugs to the Ceilometer project on
.. _git.openstack.org: https://git.openstack.org/cgit/openstack/python-ceilometerclient
.. _Launchpad: https://launchpad.net/ceilometer
-.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
+.. _Gerrit: https://docs.openstack.org/infra/manual/developers.html#development-workflow
Run tests with ``python setup.py test``.
diff --git a/doc/source/shell.rst b/doc/source/shell.rst
index 1c10c48..a35a9a1 100644
--- a/doc/source/shell.rst
+++ b/doc/source/shell.rst
@@ -58,4 +58,4 @@ Use queries to narrow your search (more info at `Ceilometer V2 API reference`__)
ceilometer sample-list --meter cpu_util --query 'resource_id=5a301761-f78b-46e2-8900-8b4f6fe6675a' --limit 10
-__ http://docs.openstack.org/developer/ceilometer/webapi/v2.html#Query
+__ https://docs.openstack.org/ceilometer/latest/webapi/v2.html#Query
diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py
index ecb154a..9ddac03 100644
--- a/releasenotes/source/conf.py
+++ b/releasenotes/source/conf.py
@@ -38,8 +38,8 @@
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
- 'oslosphinx',
'reno.sphinxext',
+ 'openstackdocstheme'
]
# Add any paths that contain templates here, relative to this directory.
@@ -112,7 +112,12 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
-html_theme = 'default'
+html_theme = 'openstackdocs'
+
+# openstackdocstheme options
+repository_name = 'openstack/python-ceilometerclient'
+bug_project = 'python-ceilometerclient'
+bug_tag = ''
# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
@@ -151,6 +156,7 @@ html_static_path = ['_static']
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y'
+html_last_updated_fmt = '%Y-%m-%d %H:%M'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
diff --git a/releasenotes/source/index.rst b/releasenotes/source/index.rst
index 616b117..17fb7a5 100644
--- a/releasenotes/source/index.rst
+++ b/releasenotes/source/index.rst
@@ -8,6 +8,7 @@ Contents
:maxdepth: 2
unreleased
+ pike
ocata
newton
mitaka
diff --git a/releasenotes/source/pike.rst b/releasenotes/source/pike.rst
new file mode 100644
index 0000000..e43bfc0
--- /dev/null
+++ b/releasenotes/source/pike.rst
@@ -0,0 +1,6 @@
+===================================
+ Pike Series Release Notes
+===================================
+
+.. release-notes::
+ :branch: stable/pike
diff --git a/setup.cfg b/setup.cfg
index 2cc1c9c..5df04f3 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -5,7 +5,7 @@ description-file =
README.rst
author = OpenStack
author-email = openstack-dev@lists.openstack.org
-home-page = http://docs.openstack.org/developer/python-ceilometerclient
+home-page = https://docs.openstack.org/python-ceilometerclient/latest/
classifier =
Environment :: OpenStack
Intended Audience :: Information Technology
diff --git a/test-requirements.txt b/test-requirements.txt
index ca1a61a..b033e82 100644
--- a/test-requirements.txt
+++ b/test-requirements.txt
@@ -5,10 +5,10 @@
coverage>=3.6 # Apache-2.0
fixtures<2.0,>=1.3.1 # Apache-2.0/BSD
mock>=1.2 # BSD
-oslosphinx!=3.4.0,>=2.5.0 # Apache-2.0
+openstackdocstheme>=1.11.0 # Apache-2.0
reno>=1.6.2 # Apache2
python-subunit>=0.0.18 # Apache-2.0/BSD
-sphinx!=1.2.0,!=1.3b1,<1.3,>=1.1.2 # BSD
+sphinx>=1.6.2 # BSD
tempest>=11.0.0 # Apache-2.0
testrepository>=0.0.18 # Apache-2.0/BSD
testtools>=1.4.0 # MIT
View Lorry Controller Status