diff options
| author | Doug Hellmann <doug@doughellmann.com> | 2017-06-13 15:55:33 -0400 |
|---|---|---|
| committer | Andreas Jaeger <aj@suse.com> | 2017-06-23 11:54:32 +0200 |
| commit | 9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch) | |
| tree | 9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/index.rst | |
| parent | 19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff) | |
| download | python-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz | |
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification.
Replace :doc: markup with :ref: to have sphinx keep track of where the
files move and generate valid hyperlinks.
Add a few toctrees and index pages for the new directories.
Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454
Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/index.rst')
| -rw-r--r-- | doc/source/index.rst | 37 |
1 files changed, 9 insertions, 28 deletions
diff --git a/doc/source/index.rst b/doc/source/index.rst index ae0ee0ff..be421d20 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -7,32 +7,19 @@ brings the command set for Compute, Identity, Image, Object Storage and Block Storage APIs together in a single shell with a uniform command structure. -User Documentation ------------------- - -.. toctree:: - :maxdepth: 1 - - Manual Page <man/openstack> - command-list - commands - configuration - plugins - plugin-commands - authentication - interactive - humaninterfaceguide - backwards-incompatible +Using OpenStackClient +--------------------- .. toctree:: :maxdepth: 2 - decoder + cli/index + configuration/index Getting Started --------------- -* Try :doc:`some commands <command-list>` +* Try :ref:`some commands <command-list>` * Read the source `on OpenStack's Git server`_ * Install OpenStackClient from `PyPi`_ or a `tarball`_ @@ -44,19 +31,13 @@ Release Notes Release Notes <http://docs.openstack.org/releasenotes/python-openstackclient> -Developer Documentation ------------------------ +Contributor Documentation +------------------------- .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - developing - command-beta - command-options - command-wrappers - command-errors - command-logs - specs/commands + contributor/index api/modules Project Goals |