diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst new file mode 100644 index 000000000..251e71c82 --- /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 similarity index 94% rename from doc/source/cli.rst rename to doc/source/cli/ironic_client.rst index 78f1ee3e0..92c02b014 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 similarity index 90% rename from doc/source/osc_plugin_cli.rst rename to doc/source/cli/osc_plugin_cli.rst index 119bc44f0..924d3e57c 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 similarity index 100% rename from doc/source/contributing.rst rename to doc/source/contributor/contributing.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 000000000..e0c982322 --- /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 similarity index 100% rename from doc/source/testing.rst rename to doc/source/contributor/testing.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index a7e7156d5..16766d761 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 Indices and tables diff --git a/doc/source/create_command.rst b/doc/source/user/create_command.rst similarity index 100% rename from doc/source/create_command.rst rename to doc/source/user/create_command.rst