diff --git a/doc/source/cli/nova-api-metadata.rst b/doc/source/cli/nova-api-metadata.rst index bee8cd285d5a..d4e3c2fa1cab 100644 --- a/doc/source/cli/nova-api-metadata.rst +++ b/doc/source/cli/nova-api-metadata.rst @@ -2,21 +2,14 @@ nova-api-metadata ================= --------------------------------- -Server for the Nova Metadata API --------------------------------- - -:Author: openstack@lists.openstack.org -:Copyright: OpenStack Foundation -:Manual section: 1 -:Manual group: cloud computing +.. program:: nova-api-metadata Synopsis ======== :: - nova-api-metadata [options] + nova-api-metadata [...] Description =========== diff --git a/doc/source/cli/nova-api-os-compute.rst b/doc/source/cli/nova-api-os-compute.rst index 56d53eed2083..5323e844cca5 100644 --- a/doc/source/cli/nova-api-os-compute.rst +++ b/doc/source/cli/nova-api-os-compute.rst @@ -2,21 +2,14 @@ nova-api-os-compute =================== ------------------------------------------- -Server for the Nova OpenStack Compute APIs ------------------------------------------- - -:Author: openstack@lists.openstack.org -:Copyright: OpenStack Foundation -:Manual section: 1 -:Manual group: cloud computing +.. program:: nova-api-os-compute Synopsis ======== :: - nova-api-os-compute [options] + nova-api-os-compute [...] Description =========== diff --git a/doc/source/cli/nova-api.rst b/doc/source/cli/nova-api.rst index ea58d671a021..d6ab82827045 100644 --- a/doc/source/cli/nova-api.rst +++ b/doc/source/cli/nova-api.rst @@ -2,21 +2,14 @@ nova-api ======== -------------------------------------- -Server for the OpenStack Compute APIs -------------------------------------- - -:Author: openstack@lists.openstack.org -:Copyright: OpenStack Foundation -:Manual section: 1 -:Manual group: cloud computing +.. program:: nova-api Synopsis ======== :: - nova-api [options] + nova-api [...] Description =========== diff --git a/doc/source/cli/nova-compute.rst b/doc/source/cli/nova-compute.rst index f48478e8be82..67776f2e9314 100644 --- a/doc/source/cli/nova-compute.rst +++ b/doc/source/cli/nova-compute.rst @@ -2,21 +2,14 @@ nova-compute ============ -------------------- -Nova Compute Server -------------------- - -:Author: openstack@lists.openstack.org -:Copyright: OpenStack Foundation -:Manual section: 1 -:Manual group: cloud computing +.. program:: nova-compute Synopsis ======== :: - nova-compute [options] + nova-compute [...] Description =========== diff --git a/doc/source/cli/nova-conductor.rst b/doc/source/cli/nova-conductor.rst index cfa538064529..d6442a152a3f 100644 --- a/doc/source/cli/nova-conductor.rst +++ b/doc/source/cli/nova-conductor.rst @@ -2,21 +2,14 @@ nova-conductor ============== ------------------------------ -Server for the Nova Conductor ------------------------------ - -:Author: openstack@lists.openstack.org -:Copyright: OpenStack Foundation -:Manual section: 1 -:Manual group: cloud computing +.. program:: nova-conductor Synopsis ======== :: - nova-conductor [options] + nova-conductor [...] Description =========== diff --git a/doc/source/cli/nova-manage.rst b/doc/source/cli/nova-manage.rst index e85b5b323ede..e2127bbfa951 100644 --- a/doc/source/cli/nova-manage.rst +++ b/doc/source/cli/nova-manage.rst @@ -4,21 +4,12 @@ nova-manage .. program:: nova-manage -------------------------------------------- -Control and manage cloud computer instances -------------------------------------------- - -:Author: openstack@lists.openstack.org -:Copyright: OpenStack Foundation -:Manual section: 1 -:Manual group: cloud computing - Synopsis ======== :: - nova-manage [] + nova-manage [ [...]] Description =========== diff --git a/doc/source/cli/nova-novncproxy.rst b/doc/source/cli/nova-novncproxy.rst index 2811474e35b5..8066d45a77ba 100644 --- a/doc/source/cli/nova-novncproxy.rst +++ b/doc/source/cli/nova-novncproxy.rst @@ -2,21 +2,14 @@ nova-novncproxy =============== -------------------------------------------------------- -Websocket novnc Proxy for OpenStack Nova noVNC consoles -------------------------------------------------------- - -:Author: openstack@lists.openstack.org -:Copyright: OpenStack Foundation -:Manual section: 1 -:Manual group: cloud computing +.. program:: nova-novncproxy Synopsis ======== :: - nova-novncproxy [options] + nova-novncproxy [...] Description =========== diff --git a/doc/source/cli/nova-rootwrap.rst b/doc/source/cli/nova-rootwrap.rst index bb2d85f6f262..6da14c4131fc 100644 --- a/doc/source/cli/nova-rootwrap.rst +++ b/doc/source/cli/nova-rootwrap.rst @@ -2,21 +2,14 @@ nova-rootwrap ============= ---------------------- -Root wrapper for Nova ---------------------- - -:Author: openstack@lists.openstack.org -:Copyright: OpenStack Foundation -:Manual section: 1 -:Manual group: cloud computing +.. program:: nova-rootwrap Synopsis ======== :: - nova-rootwrap [options] + nova-rootwrap [...] Description =========== diff --git a/doc/source/cli/nova-scheduler.rst b/doc/source/cli/nova-scheduler.rst index 30d31c265c36..6128d7960a38 100644 --- a/doc/source/cli/nova-scheduler.rst +++ b/doc/source/cli/nova-scheduler.rst @@ -2,21 +2,14 @@ nova-scheduler ============== --------------- -Nova Scheduler --------------- - -:Author: openstack@lists.openstack.org -:Copyright: OpenStack Foundation -:Manual section: 1 -:Manual group: cloud computing +.. program:: nova-scheduler Synopsis ======== :: - nova-scheduler [options] + nova-scheduler [...] Description =========== diff --git a/doc/source/cli/nova-serialproxy.rst b/doc/source/cli/nova-serialproxy.rst index cae809b1a22b..7efdc2a15332 100644 --- a/doc/source/cli/nova-serialproxy.rst +++ b/doc/source/cli/nova-serialproxy.rst @@ -2,21 +2,14 @@ nova-serialproxy ================ ------------------------------------------------------- -Websocket serial Proxy for OpenStack Nova serial ports ------------------------------------------------------- - -:Author: openstack@lists.launchpad.net -:Copyright: OpenStack Foundation -:Manual section: 1 -:Manual group: cloud computing +.. program:: nova-serialproxy Synopsis ======== :: - nova-serialproxy [options] + nova-serialproxy [...] Description =========== diff --git a/doc/source/cli/nova-spicehtml5proxy.rst b/doc/source/cli/nova-spicehtml5proxy.rst index bb98904ff667..34716aedd511 100644 --- a/doc/source/cli/nova-spicehtml5proxy.rst +++ b/doc/source/cli/nova-spicehtml5proxy.rst @@ -2,21 +2,14 @@ nova-spicehtml5proxy ==================== -------------------------------------------------------- -Websocket Proxy for OpenStack Nova SPICE HTML5 consoles -------------------------------------------------------- - -:Author: openstack@lists.openstack.org -:Copyright: OpenStack Foundation -:Manual section: 1 -:Manual group: cloud computing +.. program:: nova-spicehtml5proxy Synopsis ======== :: - nova-spicehtml5proxy [options] + nova-spicehtml5proxy [...] Description =========== diff --git a/doc/source/cli/nova-status.rst b/doc/source/cli/nova-status.rst index 94130ef19768..f226ad2f908c 100644 --- a/doc/source/cli/nova-status.rst +++ b/doc/source/cli/nova-status.rst @@ -2,21 +2,14 @@ nova-status =========== --------------------------------------- -CLI interface for nova status commands --------------------------------------- - -:Author: openstack@lists.openstack.org -:Copyright: OpenStack Foundation -:Manual section: 1 -:Manual group: cloud computing +.. program:: nova-status Synopsis ======== :: - nova-status [] + nova-status [ [...]] Description =========== diff --git a/doc/source/conf.py b/doc/source/conf.py index 4d3fe75f9a25..7ce6586cc909 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -78,22 +78,46 @@ pygments_style = 'sphinx' # List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual' _man_pages = [ - ('nova-api', u'Cloud controller fabric'), - ('nova-api-metadata', u'Cloud controller fabric'), - ('nova-api-os-compute', u'Cloud controller fabric'), - ('nova-compute', u'Cloud controller fabric'), - ('nova-conductor', u'Cloud controller fabric'), - ('nova-manage', u'Cloud controller fabric'), - ('nova-novncproxy', u'Cloud controller fabric'), - ('nova-rootwrap', u'Cloud controller fabric'), - ('nova-scheduler', u'Cloud controller fabric'), - ('nova-serialproxy', u'Cloud controller fabric'), - ('nova-spicehtml5proxy', u'Cloud controller fabric'), - ('nova-status', u'Cloud controller fabric'), + ('nova-api', 'Server for the OpenStack Compute API service.'), + ( + 'nova-api-metadata', + 'Server for the OpenStack Compute metadata API service.', + ), + ( + 'nova-api-os-compute', + 'Server for the OpenStack Compute API service.', + ), + ('nova-compute', 'Server for the OpenStack Compute compute service.'), + ('nova-conductor', 'Server for the OpenStack Compute conductor service.'), + ('nova-manage', 'Management tool for the OpenStack Compute services.'), + ( + 'nova-novncproxy', + 'Server for the OpenStack Compute VNC console proxy service.' + ), + ( + 'nova-rootwrap', + 'Root wrapper daemon for the OpenStack Compute service.', + ), + ( + 'nova-scheduler', + 'Server for the OpenStack Compute scheduler service.', + ), + ( + 'nova-serialproxy', + 'Server for the OpenStack Compute serial console proxy service.', + ), + ( + 'nova-spicehtml5proxy', + 'Server for the OpenStack Compute SPICE console proxy service.', + ), + ( + 'nova-status', + 'Inspect configuration status for the OpenStack Compute services.', + ), ] man_pages = [ - ('cli/%s' % name, name, description, [u'OpenStack'], 1) + ('cli/%s' % name, name, description, ['openstack@lists.openstack.org'], 1) for name, description in _man_pages] # -- Options for HTML output --------------------------------------------------