summaryrefslogtreecommitdiff
path: root/doc/source/conf.py
diff options
context:
space:
mode:
authorJakub Ruzicka <jruzicka@redhat.com>2013-07-31 13:07:14 -0400
committerJakub Ruzicka <jruzicka@redhat.com>2013-08-05 16:00:01 -0400
commite04232b552634a7429c94120cd02c12d86a192c1 (patch)
tree18103bc083c51a34cf9549001f929d6bb8fbd270 /doc/source/conf.py
parent55b2161c8f3edbb1cc64048f16c70af0aa039822 (diff)
downloadpython-cinderclient-e04232b552634a7429c94120cd02c12d86a192c1.tar.gz
Provide cinder CLI man page.
Provide basic but hopefully useful man page. shell.rst was merged into and replaced by the man page in HTML docs. pbr is used to determine version. Docs copyright was changed to more accurate "OpenStack Contributors". Fixes: bug 1206968 Implements: blueprint clients-man-pages Change-Id: Iedd7b4b161ced564833fd9433762b87a4c1a374d
Diffstat (limited to 'doc/source/conf.py')
-rw-r--r--doc/source/conf.py13
1 files changed, 9 insertions, 4 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index a89528d..d4ae7ca 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -13,6 +13,7 @@
import os
import sys
+import pbr.version
# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
@@ -43,16 +44,16 @@ master_doc = 'index'
# General information about the project.
project = 'python-cinderclient'
-copyright = 'Rackspace, based on work by Jacob Kaplan-Moss'
+copyright = 'OpenStack Contributors'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
-#
+version_info = pbr.version.VersionInfo('python-cinderclient')
# The short X.Y version.
-version = '2.6'
+version = version_info.version_string()
# The full version, including alpha/beta/rc tags.
-release = '2.6.10'
+release = version_info.release_string()
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
@@ -93,6 +94,10 @@ pygments_style = 'sphinx'
#modindex_common_prefix = []
+man_pages = [
+ ('man/cinder', 'cinder', u'Client for OpenStack Block Storage API',
+ [u'OpenStack Contributors'], 1),
+]
# -- Options for HTML output --------------------------------------------------
# The theme to use for HTML and HTML Help pages. Major themes that come with