From a28aad85ae992b91777a4f178a78da3ac84f9132 Mon Sep 17 00:00:00 2001 From: Eyal Date: Wed, 22 Feb 2017 13:21:20 +0200 Subject: [PATCH] some doc fixes Change-Id: I9dfe44b4703ad237a478727a89d4c81523fc0497 --- doc/source/conf.py | 2 +- doc/source/index.rst | 2 +- doc/source/usage.rst | 9 ++++++--- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 2c8a081..aed81cb 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -38,7 +38,7 @@ master_doc = 'index' # General information about the project. project = u'python-vitrageclient' -copyright = u'2013, OpenStack Foundation' +copyright = u'2016, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True diff --git a/doc/source/index.rst b/doc/source/index.rst index fb68b46..3baa276 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -4,7 +4,7 @@ contain the root `toctree` directive. Welcome to python-vitrageclient's documentation! -======================================================== +================================================ Contents: diff --git a/doc/source/usage.rst b/doc/source/usage.rst index 1fc4e85..27ac9c2 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -1,7 +1,10 @@ -======== +===== Usage -======== +===== To use python-vitrageclient in a project:: - import vitrageclient + >>> from vitrageclient.v1 import client + >>> vitrage = client.Client(...) + >>> vitrage.topology.show() +