Support dynamic documentation versioning using pbr

- Add a version.py file to allow querying of the pbr version for the package
which is pulled from the git tags
- Use this when doing the sphinx docs generation

Change-Id: I13ead2edf5b79a6ef2aa33f1b25920f83adea34c
This commit is contained in:
adreznec 2015-08-19 09:11:28 -05:00 committed by Adam Reznechek
parent 02f9f51cef
commit fb98952ba1
2 changed files with 20 additions and 2 deletions

View File

@ -53,10 +53,11 @@ copyright = u'2015, IBM'
# |version| and |release|, also used in various other places throughout the
# built documents.
#
import nova_powervm.version
# The short X.Y version.
version = '0.1.0'
version = nova_powervm.version.version_info.version_string()
# The full version, including alpha/beta/rc tags.
release = '0.1.0'
release = nova_powervm.version.version_info.release_string()
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

17
nova_powervm/version.py Normal file
View File

@ -0,0 +1,17 @@
# Copyright 2015 IBM Corp.
#
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import pbr.version
version_info = pbr.version.VersionInfo('__package__')