docs: Remove subtitles, metadata from man pages

These do not render correctly when generating man pages and likely exist
from a time when the pages were built with rst2man (i.e. docutils)
instead of Sphinx. They're not necessary when using Sphinx since that
information is provided via the 'man_pages' config option in 'conf.py',
which are updated here to reflect reality.

Change-Id: I133e7231112cc9025e57a29d43bfa7002ca775e7
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane 2020-05-21 11:05:10 +01:00
parent bfdca19bb8
commit 79e6d3e135
13 changed files with 60 additions and 122 deletions

View File

@ -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 [<options>...]
Description
===========

View File

@ -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 [<options>...]
Description
===========

View File

@ -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 [<options>...]
Description
===========

View File

@ -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 [<options>...]
Description
===========

View File

@ -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 [<options>...]
Description
===========

View File

@ -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 <category> <action> [<args>]
nova-manage <category> [<action> [<options>...]]
Description
===========

View File

@ -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 [<options>...]
Description
===========

View File

@ -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 [<options>...]
Description
===========

View File

@ -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 [<options>...]
Description
===========

View File

@ -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 [<options>...]
Description
===========

View File

@ -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 [<options>...]
Description
===========

View File

@ -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 <category> <action> [<args>]
nova-status <category> [<action> [<options>...]]
Description
===========

View File

@ -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 --------------------------------------------------