From be8fa670243ddfe3e0f954499cf5bd7b1242c985 Mon Sep 17 00:00:00 2001 From: Stephen Finucane Date: Tue, 27 Jun 2017 11:01:38 +0100 Subject: [PATCH] doc: Populate the 'cli' section MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Per the spec [1]: cli/ – command line tool reference docs, similar to man pages These may be automatically generated with cliff's sphinx integration, or manually written when auto-generation is not possible. All of the docs currently found in 'man' fit that category, so those and those alone are moved. It'll be a great day in the parish when we can replace all of these with cliff's Sphinx integration. [1] specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration Change-Id: I45bed324ec37cfea7c1a574ec06af38e7b875a1c --- doc/source/cells.rst | 4 ++-- doc/source/{man => cli}/index.rst | 0 doc/source/{man => cli}/nova-api-metadata.rst | 0 doc/source/{man => cli}/nova-api-os-compute.rst | 0 doc/source/{man => cli}/nova-api.rst | 0 doc/source/{man => cli}/nova-cells.rst | 0 doc/source/{man => cli}/nova-compute.rst | 0 doc/source/{man => cli}/nova-conductor.rst | 0 doc/source/{man => cli}/nova-console.rst | 0 doc/source/{man => cli}/nova-consoleauth.rst | 0 doc/source/{man => cli}/nova-dhcpbridge.rst | 0 doc/source/{man => cli}/nova-idmapshift.rst | 0 doc/source/{man => cli}/nova-manage.rst | 0 doc/source/{man => cli}/nova-network.rst | 0 doc/source/{man => cli}/nova-novncproxy.rst | 0 doc/source/{man => cli}/nova-rootwrap.rst | 0 doc/source/{man => cli}/nova-scheduler.rst | 0 doc/source/{man => cli}/nova-serialproxy.rst | 0 doc/source/{man => cli}/nova-spicehtml5proxy.rst | 0 doc/source/{man => cli}/nova-status.rst | 0 doc/source/{man => cli}/nova-xvpvncproxy.rst | 0 doc/source/conf.py | 2 +- doc/source/index.rst | 2 +- doc/source/placement.rst | 8 ++++---- 24 files changed, 8 insertions(+), 8 deletions(-) rename doc/source/{man => cli}/index.rst (100%) rename doc/source/{man => cli}/nova-api-metadata.rst (100%) rename doc/source/{man => cli}/nova-api-os-compute.rst (100%) rename doc/source/{man => cli}/nova-api.rst (100%) rename doc/source/{man => cli}/nova-cells.rst (100%) rename doc/source/{man => cli}/nova-compute.rst (100%) rename doc/source/{man => cli}/nova-conductor.rst (100%) rename doc/source/{man => cli}/nova-console.rst (100%) rename doc/source/{man => cli}/nova-consoleauth.rst (100%) rename doc/source/{man => cli}/nova-dhcpbridge.rst (100%) rename doc/source/{man => cli}/nova-idmapshift.rst (100%) rename doc/source/{man => cli}/nova-manage.rst (100%) rename doc/source/{man => cli}/nova-network.rst (100%) rename doc/source/{man => cli}/nova-novncproxy.rst (100%) rename doc/source/{man => cli}/nova-rootwrap.rst (100%) rename doc/source/{man => cli}/nova-scheduler.rst (100%) rename doc/source/{man => cli}/nova-serialproxy.rst (100%) rename doc/source/{man => cli}/nova-spicehtml5proxy.rst (100%) rename doc/source/{man => cli}/nova-status.rst (100%) rename doc/source/{man => cli}/nova-xvpvncproxy.rst (100%) diff --git a/doc/source/cells.rst b/doc/source/cells.rst index 781cd19e06d5..fe1165529aeb 100644 --- a/doc/source/cells.rst +++ b/doc/source/cells.rst @@ -333,7 +333,7 @@ utilized. References ~~~~~~~~~~ -* `man pages for the cells v2 commands `_ +* :doc:`nova-manage man page ` Step-By-Step for Common Use Cases ================================= @@ -555,7 +555,7 @@ you did not configure the automatic host discovery as described in step 5 in References ~~~~~~~~~~ -* `man pages for the cells v2 commands `_ +* :doc:`nova-manage man page ` FAQs ==== diff --git a/doc/source/man/index.rst b/doc/source/cli/index.rst similarity index 100% rename from doc/source/man/index.rst rename to doc/source/cli/index.rst diff --git a/doc/source/man/nova-api-metadata.rst b/doc/source/cli/nova-api-metadata.rst similarity index 100% rename from doc/source/man/nova-api-metadata.rst rename to doc/source/cli/nova-api-metadata.rst diff --git a/doc/source/man/nova-api-os-compute.rst b/doc/source/cli/nova-api-os-compute.rst similarity index 100% rename from doc/source/man/nova-api-os-compute.rst rename to doc/source/cli/nova-api-os-compute.rst diff --git a/doc/source/man/nova-api.rst b/doc/source/cli/nova-api.rst similarity index 100% rename from doc/source/man/nova-api.rst rename to doc/source/cli/nova-api.rst diff --git a/doc/source/man/nova-cells.rst b/doc/source/cli/nova-cells.rst similarity index 100% rename from doc/source/man/nova-cells.rst rename to doc/source/cli/nova-cells.rst diff --git a/doc/source/man/nova-compute.rst b/doc/source/cli/nova-compute.rst similarity index 100% rename from doc/source/man/nova-compute.rst rename to doc/source/cli/nova-compute.rst diff --git a/doc/source/man/nova-conductor.rst b/doc/source/cli/nova-conductor.rst similarity index 100% rename from doc/source/man/nova-conductor.rst rename to doc/source/cli/nova-conductor.rst diff --git a/doc/source/man/nova-console.rst b/doc/source/cli/nova-console.rst similarity index 100% rename from doc/source/man/nova-console.rst rename to doc/source/cli/nova-console.rst diff --git a/doc/source/man/nova-consoleauth.rst b/doc/source/cli/nova-consoleauth.rst similarity index 100% rename from doc/source/man/nova-consoleauth.rst rename to doc/source/cli/nova-consoleauth.rst diff --git a/doc/source/man/nova-dhcpbridge.rst b/doc/source/cli/nova-dhcpbridge.rst similarity index 100% rename from doc/source/man/nova-dhcpbridge.rst rename to doc/source/cli/nova-dhcpbridge.rst diff --git a/doc/source/man/nova-idmapshift.rst b/doc/source/cli/nova-idmapshift.rst similarity index 100% rename from doc/source/man/nova-idmapshift.rst rename to doc/source/cli/nova-idmapshift.rst diff --git a/doc/source/man/nova-manage.rst b/doc/source/cli/nova-manage.rst similarity index 100% rename from doc/source/man/nova-manage.rst rename to doc/source/cli/nova-manage.rst diff --git a/doc/source/man/nova-network.rst b/doc/source/cli/nova-network.rst similarity index 100% rename from doc/source/man/nova-network.rst rename to doc/source/cli/nova-network.rst diff --git a/doc/source/man/nova-novncproxy.rst b/doc/source/cli/nova-novncproxy.rst similarity index 100% rename from doc/source/man/nova-novncproxy.rst rename to doc/source/cli/nova-novncproxy.rst diff --git a/doc/source/man/nova-rootwrap.rst b/doc/source/cli/nova-rootwrap.rst similarity index 100% rename from doc/source/man/nova-rootwrap.rst rename to doc/source/cli/nova-rootwrap.rst diff --git a/doc/source/man/nova-scheduler.rst b/doc/source/cli/nova-scheduler.rst similarity index 100% rename from doc/source/man/nova-scheduler.rst rename to doc/source/cli/nova-scheduler.rst diff --git a/doc/source/man/nova-serialproxy.rst b/doc/source/cli/nova-serialproxy.rst similarity index 100% rename from doc/source/man/nova-serialproxy.rst rename to doc/source/cli/nova-serialproxy.rst diff --git a/doc/source/man/nova-spicehtml5proxy.rst b/doc/source/cli/nova-spicehtml5proxy.rst similarity index 100% rename from doc/source/man/nova-spicehtml5proxy.rst rename to doc/source/cli/nova-spicehtml5proxy.rst diff --git a/doc/source/man/nova-status.rst b/doc/source/cli/nova-status.rst similarity index 100% rename from doc/source/man/nova-status.rst rename to doc/source/cli/nova-status.rst diff --git a/doc/source/man/nova-xvpvncproxy.rst b/doc/source/cli/nova-xvpvncproxy.rst similarity index 100% rename from doc/source/man/nova-xvpvncproxy.rst rename to doc/source/cli/nova-xvpvncproxy.rst diff --git a/doc/source/conf.py b/doc/source/conf.py index ee058977b69c..42df54be228d 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -123,7 +123,7 @@ _man_pages = [ ] man_pages = [ - ('man/%s' % name, name, description, [u'OpenStack'], 1) + ('cli/%s' % name, name, description, [u'OpenStack'], 1) for name, description in _man_pages] # -- Options for HTML output -------------------------------------------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index 8ff6ee3e20c1..4dcd5466e4d4 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -215,7 +215,7 @@ Man Pages .. toctree:: :maxdepth: 1 - man/index + cli/index Module Reference ---------------- diff --git a/doc/source/placement.rst b/doc/source/placement.rst index ef9779ad2cc1..b0cb0da283d8 100644 --- a/doc/source/placement.rst +++ b/doc/source/placement.rst @@ -142,11 +142,11 @@ Upgrade Notes The follow sub-sections provide notes on upgrading to a given target release. -.. note:: As a reminder, the `nova-status upgrade check`_ tool can be used to - help determine the status of your deployment and how ready it is to perform - an upgrade. +.. note:: -.. _nova-status upgrade check: http://docs.openstack.org/developer/nova/man/nova-status.html + As a reminder, the :doc:`nova-status upgrade check ` tool + can be used to help determine the status of your deployment and how ready it + is to perform an upgrade. Ocata (15.0.0) ~~~~~~~~~~~~~~