openstack/python-vitrageclient
Code Issues Proposed changes

some doc fixes

Browse Source 
Change-Id: I9dfe44b4703ad237a478727a89d4c81523fc0497
This commit is contained in:
Eyal 2017-02-22 13:21:20 +02:00
parent 5b26c6cf8c
commit a28aad85ae
3 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/source/conf.py
View File

@ -38,7 +38,7 @@ master_doc = 'index'
# General information about the project. # General information about the project.
project = u'python-vitrageclient' 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. # If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True add_function_parentheses = True

2
doc/source/index.rst
View File

@ -4,7 +4,7 @@
contain the root `toctree` directive. contain the root `toctree` directive.
Welcome to python-vitrageclient's documentation! Welcome to python-vitrageclient's documentation!
======================================================== ================================================
Contents: Contents:

9
doc/source/usage.rst
View File

@ -1,7 +1,10 @@
======== =====
Usage Usage
======== =====
To use python-vitrageclient in a project:: To use python-vitrageclient in a project::
import vitrageclient >>> from vitrageclient.v1 import client
>>> vitrage = client.Client(...)
>>> vitrage.topology.show()