openstack/nova
Code Issues Proposed changes

Merge "docs: Remove subtitles, metadata from man pages"

Browse Source
This commit is contained in:
Zuul 2020-06-02 14:28:33 +00:00 committed by Gerrit Code Review
commit 6f6b63ee5f
13 changed files with 60 additions and 122 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
doc/source/cli/nova-api-metadata.rst
View File

@ -2,21 +2,14 @@
nova-api-metadata nova-api-metadata
================= =================
-------------------------------- .. program:: nova-api-metadata
Server for the Nova Metadata API
--------------------------------
:Author: openstack@lists.openstack.org
:Copyright: OpenStack Foundation
:Manual section: 1
:Manual group: cloud computing
Synopsis Synopsis
======== ========
:: ::
nova-api-metadata [options] nova-api-metadata [<options>...]
Description Description
=========== ===========

11
doc/source/cli/nova-api-os-compute.rst
View File

@ -2,21 +2,14 @@
nova-api-os-compute nova-api-os-compute
=================== ===================
------------------------------------------ .. program:: 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
Synopsis Synopsis
======== ========
:: ::
nova-api-os-compute [options] nova-api-os-compute [<options>...]
Description Description
=========== ===========

11
doc/source/cli/nova-api.rst
View File

@ -2,21 +2,14 @@
nova-api nova-api
======== ========
------------------------------------- .. program:: nova-api
Server for the OpenStack Compute APIs
-------------------------------------
:Author: openstack@lists.openstack.org
:Copyright: OpenStack Foundation
:Manual section: 1
:Manual group: cloud computing
Synopsis Synopsis
======== ========
:: ::
nova-api [options] nova-api [<options>...]
Description Description
=========== ===========

11
doc/source/cli/nova-compute.rst
View File

@ -2,21 +2,14 @@
nova-compute nova-compute
============ ============
------------------- .. program:: nova-compute
Nova Compute Server
-------------------
:Author: openstack@lists.openstack.org
:Copyright: OpenStack Foundation
:Manual section: 1
:Manual group: cloud computing
Synopsis Synopsis
======== ========
:: ::
nova-compute [options] nova-compute [<options>...]
Description Description
=========== ===========

11
doc/source/cli/nova-conductor.rst
View File

@ -2,21 +2,14 @@
nova-conductor nova-conductor
============== ==============
----------------------------- .. program:: nova-conductor
Server for the Nova Conductor
-----------------------------
:Author: openstack@lists.openstack.org
:Copyright: OpenStack Foundation
:Manual section: 1
:Manual group: cloud computing
Synopsis Synopsis
======== ========
:: ::
nova-conductor [options] nova-conductor [<options>...]
Description Description
=========== ===========

11
doc/source/cli/nova-manage.rst
View File

@ -4,21 +4,12 @@ nova-manage
.. program:: 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 Synopsis
======== ========
:: ::
nova-manage <category> <action> [<args>] nova-manage <category> [<action> [<options>...]]
Description Description
=========== ===========

11
doc/source/cli/nova-novncproxy.rst
View File

@ -2,21 +2,14 @@
nova-novncproxy nova-novncproxy
=============== ===============
------------------------------------------------------- .. program:: 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
Synopsis Synopsis
======== ========
:: ::
nova-novncproxy [options] nova-novncproxy [<options>...]
Description Description
=========== ===========

11
doc/source/cli/nova-rootwrap.rst
View File

@ -2,21 +2,14 @@
nova-rootwrap nova-rootwrap
============= =============
--------------------- .. program:: nova-rootwrap
Root wrapper for Nova
---------------------
:Author: openstack@lists.openstack.org
:Copyright: OpenStack Foundation
:Manual section: 1
:Manual group: cloud computing
Synopsis Synopsis
======== ========
:: ::
nova-rootwrap [options] nova-rootwrap [<options>...]
Description Description
=========== ===========

11
doc/source/cli/nova-scheduler.rst
View File

@ -2,21 +2,14 @@
nova-scheduler nova-scheduler
============== ==============
-------------- .. program:: nova-scheduler
Nova Scheduler
--------------
:Author: openstack@lists.openstack.org
:Copyright: OpenStack Foundation
:Manual section: 1
:Manual group: cloud computing
Synopsis Synopsis
======== ========
:: ::
nova-scheduler [options] nova-scheduler [<options>...]
Description Description
=========== ===========

11
doc/source/cli/nova-serialproxy.rst
View File

@ -2,21 +2,14 @@
nova-serialproxy nova-serialproxy
================ ================
------------------------------------------------------ .. program:: 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
Synopsis Synopsis
======== ========
:: ::
nova-serialproxy [options] nova-serialproxy [<options>...]
Description Description
=========== ===========

11
doc/source/cli/nova-spicehtml5proxy.rst
View File

@ -2,21 +2,14 @@
nova-spicehtml5proxy nova-spicehtml5proxy
==================== ====================
------------------------------------------------------- .. program:: 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
Synopsis Synopsis
======== ========
:: ::
nova-spicehtml5proxy [options] nova-spicehtml5proxy [<options>...]
Description Description
=========== ===========

11
doc/source/cli/nova-status.rst
View File

@ -2,21 +2,14 @@
nova-status nova-status
=========== ===========
-------------------------------------- .. program:: nova-status
CLI interface for nova status commands
--------------------------------------
:Author: openstack@lists.openstack.org
:Copyright: OpenStack Foundation
:Manual section: 1
:Manual group: cloud computing
Synopsis Synopsis
======== ========
:: ::
nova-status <category> <action> [<args>] nova-status <category> [<action> [<options>...]]
Description Description
=========== ===========

50
doc/source/conf.py
View File

@ -78,22 +78,46 @@ pygments_style = 'native'
# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual' # List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
_man_pages = [ _man_pages = [
('nova-api', u'Cloud controller fabric'), ('nova-api', 'Server for the OpenStack Compute API service.'),
('nova-api-metadata', u'Cloud controller fabric'), (
('nova-api-os-compute', u'Cloud controller fabric'), 'nova-api-metadata',
('nova-compute', u'Cloud controller fabric'), 'Server for the OpenStack Compute metadata API service.',
('nova-conductor', u'Cloud controller fabric'), ),
('nova-manage', u'Cloud controller fabric'), (
('nova-novncproxy', u'Cloud controller fabric'), 'nova-api-os-compute',
('nova-rootwrap', u'Cloud controller fabric'), 'Server for the OpenStack Compute API service.',
('nova-scheduler', u'Cloud controller fabric'), ),
('nova-serialproxy', u'Cloud controller fabric'), ('nova-compute', 'Server for the OpenStack Compute compute service.'),
('nova-spicehtml5proxy', u'Cloud controller fabric'), ('nova-conductor', 'Server for the OpenStack Compute conductor service.'),
('nova-status', u'Cloud controller fabric'), ('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 = [ 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] for name, description in _man_pages]
# -- Options for HTML output -------------------------------------------------- # -- Options for HTML output --------------------------------------------------