summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2017-07-13 18:23:27 +0000
committerGerrit Code Review <review@openstack.org>2017-07-13 18:23:27 +0000
commitb46674871ab9ea9fad79f3f27c7a2ca099fa5340 (patch)
treeaaf61be0f090022367fd6614096ca04897ebc1da
parent3247469bd7ab2212fd18815909edeb76bc9386b7 (diff)
parentd88dca0374ddaa32f9ab443c6dcd9f2aced9c8dc (diff)
downloadpython-ironicclient-b46674871ab9ea9fad79f3f27c7a2ca099fa5340.tar.gz
Merge "Rearrange existing documentation to fit the new standard layout"
-rw-r--r--doc/source/cli/index.rst8
-rw-r--r--doc/source/cli/ironic_client.rst (renamed from doc/source/cli.rst)6
-rw-r--r--doc/source/cli/osc_plugin_cli.rst (renamed from doc/source/osc_plugin_cli.rst)6
-rw-r--r--doc/source/contributor/contributing.rst (renamed from doc/source/contributing.rst)0
-rw-r--r--doc/source/contributor/index.rst8
-rw-r--r--doc/source/contributor/testing.rst (renamed from doc/source/testing.rst)0
-rw-r--r--doc/source/index.rst10
-rw-r--r--doc/source/user/create_command.rst (renamed from doc/source/create_command.rst)0
8 files changed, 26 insertions, 12 deletions
diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst
new file mode 100644
index 0000000..251e71c
--- /dev/null
+++ b/doc/source/cli/index.rst
@@ -0,0 +1,8 @@
+======================================
+python-ironicclient User Documentation
+======================================
+
+.. toctree::
+
+ ironic_client
+ osc_plugin_cli
diff --git a/doc/source/cli.rst b/doc/source/cli/ironic_client.rst
index 78f1ee3..92c02b0 100644
--- a/doc/source/cli.rst
+++ b/doc/source/cli/ironic_client.rst
@@ -1,6 +1,6 @@
-==============================================
-:program:`ironic` Command-Line Interface (CLI)
-==============================================
+==========================================
+Ironic Client Command-Line Interface (CLI)
+==========================================
.. program:: ironic
.. highlight:: bash
diff --git a/doc/source/osc_plugin_cli.rst b/doc/source/cli/osc_plugin_cli.rst
index 119bc44..924d3e5 100644
--- a/doc/source/osc_plugin_cli.rst
+++ b/doc/source/cli/osc_plugin_cli.rst
@@ -1,6 +1,6 @@
-============================================================================
-:program:`openstack baremetal` OpenStack Client Command-Line Interface (CLI)
-============================================================================
+=============================================
+OpenStack Client Command-Line Interface (CLI)
+=============================================
.. program:: openstack baremetal
.. highlight:: bash
diff --git a/doc/source/contributing.rst b/doc/source/contributor/contributing.rst
index 18e8cab..18e8cab 100644
--- a/doc/source/contributing.rst
+++ b/doc/source/contributor/contributing.rst
diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst
new file mode 100644
index 0000000..e0c9823
--- /dev/null
+++ b/doc/source/contributor/index.rst
@@ -0,0 +1,8 @@
+=============================================
+python-ironicclient Contributor Documentation
+=============================================
+
+.. toctree::
+
+ contributing
+ testing
diff --git a/doc/source/testing.rst b/doc/source/contributor/testing.rst
index 97a6491..97a6491 100644
--- a/doc/source/testing.rst
+++ b/doc/source/contributor/testing.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
index a7e7156..16766d7 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -10,14 +10,12 @@ Contents
========
.. toctree::
- :maxdepth: 1
+ :maxdepth: 2
api_v1
- cli
- osc_plugin_cli
- create_command
- contributing
- testing
+ cli/index
+ user/create_command
+ contributor/index
Release Notes <http://docs.openstack.org/releasenotes/python-ironicclient/>
Indices and tables
diff --git a/doc/source/create_command.rst b/doc/source/user/create_command.rst
index ec966c9..ec966c9 100644
--- a/doc/source/create_command.rst
+++ b/doc/source/user/create_command.rst