diff options
| author | Steve Martinelli <stevemar@ca.ibm.com> | 2015-08-08 01:07:07 -0700 |
|---|---|---|
| committer | Steve Martinelli <stevemar@ca.ibm.com> | 2015-08-08 08:32:03 +0000 |
| commit | d833d377cbd86b1f3cddb284c4ede24cbece3263 (patch) | |
| tree | bb633e37d2574b671ea183c783df044127226a8c /doc/source/index.rst | |
| parent | 51ae8c78b913a72826f8409e84155148986b7b09 (diff) | |
| download | python-openstackclient-d833d377cbd86b1f3cddb284c4ede24cbece3263.tar.gz | |
Add developer documentation
OSC was missing developer docs, these are critically helpful for
new developers. Add sections related to running tests (tox,
functional and with the debugger), and generating docs locally.
implements bp: developer-documentation
Change-Id: I428d89c3e5fc335864bc4f7843506043ec332fe5
Diffstat (limited to 'doc/source/index.rst')
| -rw-r--r-- | doc/source/index.rst | 10 |
1 files changed, 9 insertions, 1 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index a3bc58e4..c90b8e52 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -6,7 +6,8 @@ OpenStackClient (aka OSC) is a command-line client for OpenStack that brings the command set for Compute, Identity, Image, Object Store and Volume APIs together in a single shell with a uniform command structure. -Contents: +User Documentation +------------------ .. toctree:: :maxdepth: 1 @@ -29,6 +30,13 @@ Getting Started * Read the source `on OpenStack's Git server`_ * Install OpenStackClient from `PyPi`_ or a `tarball`_ +Developer Documentation +----------------------- + +.. toctree:: + :maxdepth: 1 + + developing Project Goals ------------- |