Skip to content

Commit 25051a7

Browse files
author
Matt Joyce
committed
Updating Readme Document
Change-Id: I0c0f5c86b0bfa96ab4d7236eb2e7e7efab6fbac0
1 parent 732863b commit 25051a7

1 file changed

Lines changed: 54 additions & 1 deletion

File tree

‎README.rst‎

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,35 @@ operations in OpenStack.
1414
python-openstackclient is designed to add support for API extensions via a
1515
plugin mechanism
1616

17+
For release management:
18+
19+
* https://launchpad.net/python-openstackclient
20+
21+
For blueprints and feature specifications:
22+
23+
* https://blueprints.launchpad.net/python-openstackclient
24+
25+
For issue tracking:
26+
27+
* https://bugs.launchpad.net/python-openstackclient
28+
29+
Getting Started
30+
===============
31+
32+
Once you have downloaded the client it can be built from setup.py with::
33+
python setup.py install
34+
35+
Alternatively you can build without installing with::
36+
python setup.py build
37+
38+
Toxicity tests can be ran simply by running ``run_tests.sh``
39+
40+
The client can be called interactively by simply typing::
41+
openstack
42+
43+
Alternatively command line parameters can be called non-interactively::
44+
openstack --help
45+
1746

1847
Configuration
1948
=============
@@ -54,4 +83,28 @@ are listed here::
5483
(via httplib2)
5584
--verbose | -v # Increase verbosity of output. Can be repeated.
5685
--quiet | -q # suppress output except warnings and errors
57-
--help | -h # show a help message and exit
86+
--help | -h # show a help message and exit
87+
88+
Building Contributor Documentation
89+
==================================
90+
91+
This documentation is written by contributors, for contributors.
92+
93+
The source is maintained in the ``docs/source`` folder using
94+
`reStructuredText`_ and built by `Sphinx`_
95+
96+
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
97+
.. _Sphinx: http://sphinx.pocoo.org/
98+
99+
* Building Automatically::
100+
101+
$ ./run_tests.sh --docs
102+
103+
* Building Manually::
104+
105+
$ export DJANGO_SETTINGS_MODULE=local.local_settings
106+
$ python doc/generate_autodoc_index.py
107+
$ sphinx-build -b html doc/source build/sphinx/html
108+
109+
Results are in the `build/sphinx/html` directory
110+

0 commit comments

Comments
 (0)