Updating Readme Document
Change-Id: I0c0f5c86b0bfa96ab4d7236eb2e7e7efab6fbac0
This commit is contained in:
parent
732863b9b7
commit
25051a733d
53
README.rst
53
README.rst
@ -14,6 +14,35 @@ operations in OpenStack.
|
|||||||
python-openstackclient is designed to add support for API extensions via a
|
python-openstackclient is designed to add support for API extensions via a
|
||||||
plugin mechanism
|
plugin mechanism
|
||||||
|
|
||||||
|
For release management:
|
||||||
|
|
||||||
|
* https://launchpad.net/python-openstackclient
|
||||||
|
|
||||||
|
For blueprints and feature specifications:
|
||||||
|
|
||||||
|
* https://blueprints.launchpad.net/python-openstackclient
|
||||||
|
|
||||||
|
For issue tracking:
|
||||||
|
|
||||||
|
* https://bugs.launchpad.net/python-openstackclient
|
||||||
|
|
||||||
|
Getting Started
|
||||||
|
===============
|
||||||
|
|
||||||
|
Once you have downloaded the client it can be built from setup.py with::
|
||||||
|
python setup.py install
|
||||||
|
|
||||||
|
Alternatively you can build without installing with::
|
||||||
|
python setup.py build
|
||||||
|
|
||||||
|
Toxicity tests can be ran simply by running ``run_tests.sh``
|
||||||
|
|
||||||
|
The client can be called interactively by simply typing::
|
||||||
|
openstack
|
||||||
|
|
||||||
|
Alternatively command line parameters can be called non-interactively::
|
||||||
|
openstack --help
|
||||||
|
|
||||||
|
|
||||||
Configuration
|
Configuration
|
||||||
=============
|
=============
|
||||||
@ -55,3 +84,27 @@ are listed here::
|
|||||||
--verbose | -v # Increase verbosity of output. Can be repeated.
|
--verbose | -v # Increase verbosity of output. Can be repeated.
|
||||||
--quiet | -q # suppress output except warnings and errors
|
--quiet | -q # suppress output except warnings and errors
|
||||||
--help | -h # show a help message and exit
|
--help | -h # show a help message and exit
|
||||||
|
|
||||||
|
Building Contributor Documentation
|
||||||
|
==================================
|
||||||
|
|
||||||
|
This documentation is written by contributors, for contributors.
|
||||||
|
|
||||||
|
The source is maintained in the ``docs/source`` folder using
|
||||||
|
`reStructuredText`_ and built by `Sphinx`_
|
||||||
|
|
||||||
|
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
|
||||||
|
.. _Sphinx: http://sphinx.pocoo.org/
|
||||||
|
|
||||||
|
* Building Automatically::
|
||||||
|
|
||||||
|
$ ./run_tests.sh --docs
|
||||||
|
|
||||||
|
* Building Manually::
|
||||||
|
|
||||||
|
$ export DJANGO_SETTINGS_MODULE=local.local_settings
|
||||||
|
$ python doc/generate_autodoc_index.py
|
||||||
|
$ sphinx-build -b html doc/source build/sphinx/html
|
||||||
|
|
||||||
|
Results are in the `build/sphinx/html` directory
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user