Refactor Commands section
Rename this section to 'Watcher Manual Pages' and add man RST files. Partial-Bug: #1535244 Change-Id: I1c890c8d053238aa568075d844f97b1e4289adcb
This commit is contained in:
parent
f675003076
commit
eaed650000
@ -11,19 +11,14 @@
|
|||||||
# implied.
|
# implied.
|
||||||
# See the License for the specific language governing permissions and
|
# See the License for the specific language governing permissions and
|
||||||
# limitations under the License.
|
# limitations under the License.
|
||||||
|
|
||||||
import os
|
|
||||||
import sys
|
|
||||||
from watcher import version as watcher_version
|
from watcher import version as watcher_version
|
||||||
|
|
||||||
sys.path.insert(0, os.path.abspath('../..'))
|
|
||||||
# -- General configuration ----------------------------------------------------
|
# -- General configuration ----------------------------------------------------
|
||||||
|
|
||||||
# Add any Sphinx extension module names here, as strings. They can be
|
# Add any Sphinx extension module names here, as strings. They can be
|
||||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = [
|
extensions = [
|
||||||
'sphinx.ext.autodoc',
|
'sphinx.ext.autodoc',
|
||||||
# 'sphinx.ext.intersphinx',
|
|
||||||
'sphinx.ext.viewcode',
|
'sphinx.ext.viewcode',
|
||||||
'sphinxcontrib.httpdomain',
|
'sphinxcontrib.httpdomain',
|
||||||
'sphinxcontrib.pecanwsme.rest',
|
'sphinxcontrib.pecanwsme.rest',
|
||||||
@ -46,8 +41,8 @@ source_suffix = '.rst'
|
|||||||
master_doc = 'index'
|
master_doc = 'index'
|
||||||
|
|
||||||
# General information about the project.
|
# General information about the project.
|
||||||
project = u'watcher'
|
project = u'Watcher'
|
||||||
copyright = u'2015, OpenStack Foundation'
|
copyright = u'OpenStack Foundation'
|
||||||
|
|
||||||
# The version info for the project you're documenting, acts as replacement for
|
# The version info for the project you're documenting, acts as replacement for
|
||||||
# |version| and |release|, also used in various other places throughout the
|
# |version| and |release|, also used in various other places throughout the
|
||||||
@ -62,6 +57,14 @@ version = watcher_version.version_info.version_string()
|
|||||||
# A list of ignored prefixes for module index sorting.
|
# A list of ignored prefixes for module index sorting.
|
||||||
modindex_common_prefix = ['watcher.']
|
modindex_common_prefix = ['watcher.']
|
||||||
|
|
||||||
|
exclude_patterns = [
|
||||||
|
# The man directory includes some snippet files that are included
|
||||||
|
# in other documents during the build but that should not be
|
||||||
|
# included in the toctree themselves, so tell Sphinx to ignore
|
||||||
|
# them when scanning for input files.
|
||||||
|
'man/footer.rst',
|
||||||
|
'man/general_options.rst',
|
||||||
|
]
|
||||||
|
|
||||||
# If true, '()' will be appended to :func: etc. cross-reference text.
|
# If true, '()' will be appended to :func: etc. cross-reference text.
|
||||||
add_function_parentheses = True
|
add_function_parentheses = True
|
||||||
@ -73,6 +76,22 @@ add_module_names = True
|
|||||||
# The name of the Pygments (syntax highlighting) style to use.
|
# The name of the Pygments (syntax highlighting) style to use.
|
||||||
pygments_style = 'sphinx'
|
pygments_style = 'sphinx'
|
||||||
|
|
||||||
|
# -- Options for man page output --------------------------------------------
|
||||||
|
|
||||||
|
# Grouping the document tree for man pages.
|
||||||
|
# List of tuples 'sourcefile', 'target', u'title', u'Authors name', 'manual'
|
||||||
|
|
||||||
|
man_pages = [
|
||||||
|
('man/watcher-api', 'watcher-api', u'Watcher API Server',
|
||||||
|
[u'OpenStack'], 1),
|
||||||
|
('man/watcher-applier', 'watcher-applier', u'Watcher Applier',
|
||||||
|
[u'OpenStack'], 1),
|
||||||
|
('man/watcher-db-manage', 'watcher-db-manage',
|
||||||
|
u'Watcher Db Management Utility', [u'OpenStack'], 1),
|
||||||
|
('man/watcher-decision-engine', 'watcher-decision-engine',
|
||||||
|
u'Watcher Decision Engine', [u'OpenStack'], 1),
|
||||||
|
]
|
||||||
|
|
||||||
# -- Options for HTML output --------------------------------------------------
|
# -- Options for HTML output --------------------------------------------------
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
# The theme to use for HTML and HTML Help pages. Major themes that come with
|
||||||
|
@ -62,13 +62,14 @@ Overview
|
|||||||
deploy/user-guide
|
deploy/user-guide
|
||||||
deploy/installation
|
deploy/installation
|
||||||
|
|
||||||
Commands
|
Watcher Manual Pages
|
||||||
--------
|
====================
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
cmds/watcher-db-manage
|
man/*
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
Indices and tables
|
||||||
|
4
doc/source/man/footer.rst
Normal file
4
doc/source/man/footer.rst
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
BUGS
|
||||||
|
====
|
||||||
|
|
||||||
|
* Watcher bugs are tracked in Launchpad at `OpenStack Watcher <http://bugs.launchpad.net/watcher>`__
|
66
doc/source/man/general-options.rst
Normal file
66
doc/source/man/general-options.rst
Normal file
@ -0,0 +1,66 @@
|
|||||||
|
**-h, --help**
|
||||||
|
Show the help message and exit
|
||||||
|
|
||||||
|
**--version**
|
||||||
|
Print the version number and exit
|
||||||
|
|
||||||
|
**-v, --verbose**
|
||||||
|
Print more verbose output
|
||||||
|
|
||||||
|
**--noverbose**
|
||||||
|
Disable verbose output
|
||||||
|
|
||||||
|
**-d, --debug**
|
||||||
|
Print debugging output (set logging level to DEBUG instead of
|
||||||
|
default WARNING level)
|
||||||
|
|
||||||
|
**--nodebug**
|
||||||
|
Disable debugging output
|
||||||
|
|
||||||
|
**--use-syslog**
|
||||||
|
Use syslog for logging
|
||||||
|
|
||||||
|
**--nouse-syslog**
|
||||||
|
Disable the use of syslog for logging
|
||||||
|
|
||||||
|
**--syslog-log-facility SYSLOG_LOG_FACILITY**
|
||||||
|
syslog facility to receive log lines
|
||||||
|
|
||||||
|
**--config-dir DIR**
|
||||||
|
Path to a config directory to pull \*.conf files from. This
|
||||||
|
file set is sorted, to provide a predictable parse order
|
||||||
|
if individual options are over-ridden. The set is parsed after
|
||||||
|
the file(s) specified via previous --config-file, arguments hence
|
||||||
|
over-ridden options in the directory take precedence. This means
|
||||||
|
that configuration from files in a specified config-dir will
|
||||||
|
always take precedence over configuration from files specified
|
||||||
|
by --config-file, regardless to argument order.
|
||||||
|
|
||||||
|
**--config-file PATH**
|
||||||
|
Path to a config file to use. Multiple config files can be
|
||||||
|
specified by using this flag multiple times, for example,
|
||||||
|
--config-file <file1> --config-file <file2>. Values in latter
|
||||||
|
files take precedence.
|
||||||
|
|
||||||
|
**--log-config-append PATH** **--log-config PATH**
|
||||||
|
The name of logging configuration file. It does not
|
||||||
|
disable existing loggers, but just appends specified
|
||||||
|
logging configuration to any other existing logging
|
||||||
|
options. Please see the Python logging module documentation
|
||||||
|
for details on logging configuration files. The log-config
|
||||||
|
name for this option is depcrecated.
|
||||||
|
|
||||||
|
**--log-format FORMAT**
|
||||||
|
A logging.Formatter log message format string which may use any
|
||||||
|
of the available logging.LogRecord attributes. Default: None
|
||||||
|
|
||||||
|
**--log-date-format DATE_FORMAT**
|
||||||
|
Format string for %(asctime)s in log records. Default: None
|
||||||
|
|
||||||
|
**--log-file PATH, --logfile PATH**
|
||||||
|
(Optional) Name of log file to output to. If not set, logging
|
||||||
|
will go to stdout.
|
||||||
|
|
||||||
|
**--log-dir LOG_DIR, --logdir LOG_DIR**
|
||||||
|
(Optional) The directory to keep log files in (will be prepended
|
||||||
|
to --log-file)
|
39
doc/source/man/watcher-api.rst
Normal file
39
doc/source/man/watcher-api.rst
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
===========
|
||||||
|
watcher-api
|
||||||
|
===========
|
||||||
|
|
||||||
|
---------------------------
|
||||||
|
Service for the Watcher API
|
||||||
|
---------------------------
|
||||||
|
|
||||||
|
:Author: openstack@lists.launchpad.net
|
||||||
|
:Date:
|
||||||
|
:Copyright: OpenStack Foundation
|
||||||
|
:Version:
|
||||||
|
:Manual section: 1
|
||||||
|
:Manual group: cloud computing
|
||||||
|
|
||||||
|
SYNOPSIS
|
||||||
|
========
|
||||||
|
|
||||||
|
watcher-api [options]
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
===========
|
||||||
|
|
||||||
|
watcher-api is a server daemon that serves the Watcher API
|
||||||
|
|
||||||
|
OPTIONS
|
||||||
|
=======
|
||||||
|
|
||||||
|
**General options**
|
||||||
|
|
||||||
|
.. include:: general-options.rst
|
||||||
|
|
||||||
|
FILES
|
||||||
|
=====
|
||||||
|
|
||||||
|
**/etc/watcher/watcher.conf**
|
||||||
|
Default configuration file for Watcher API
|
||||||
|
|
||||||
|
.. include:: footer.rst
|
39
doc/source/man/watcher-applier.rst
Normal file
39
doc/source/man/watcher-applier.rst
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
===============
|
||||||
|
watcher-applier
|
||||||
|
===============
|
||||||
|
|
||||||
|
-------------------------------
|
||||||
|
Service for the Watcher Applier
|
||||||
|
-------------------------------
|
||||||
|
|
||||||
|
:Author: openstack@lists.launchpad.net
|
||||||
|
:Date:
|
||||||
|
:Copyright: OpenStack Foundation
|
||||||
|
:Version:
|
||||||
|
:Manual section: 1
|
||||||
|
:Manual group: cloud computing
|
||||||
|
|
||||||
|
SYNOPSIS
|
||||||
|
========
|
||||||
|
|
||||||
|
watcher-applier [options]
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
===========
|
||||||
|
|
||||||
|
:ref:`Watcher Applier <watcher_applier_definition>`
|
||||||
|
|
||||||
|
OPTIONS
|
||||||
|
=======
|
||||||
|
|
||||||
|
**General options**
|
||||||
|
|
||||||
|
.. include:: general-options.rst
|
||||||
|
|
||||||
|
FILES
|
||||||
|
=====
|
||||||
|
|
||||||
|
**/etc/watcher/watcher.conf**
|
||||||
|
Default configuration file for Watcher Applier
|
||||||
|
|
||||||
|
.. include:: footer.rst
|
39
doc/source/man/watcher-decision-engine.rst
Normal file
39
doc/source/man/watcher-decision-engine.rst
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
=======================
|
||||||
|
watcher-decision-engine
|
||||||
|
=======================
|
||||||
|
|
||||||
|
---------------------------------------
|
||||||
|
Service for the Watcher Decision Engine
|
||||||
|
---------------------------------------
|
||||||
|
|
||||||
|
:Author: openstack@lists.launchpad.net
|
||||||
|
:Date:
|
||||||
|
:Copyright: OpenStack Foundation
|
||||||
|
:Version:
|
||||||
|
:Manual section: 1
|
||||||
|
:Manual group: cloud computing
|
||||||
|
|
||||||
|
SYNOPSIS
|
||||||
|
========
|
||||||
|
|
||||||
|
watcher-decision-engine [options]
|
||||||
|
|
||||||
|
DESCRIPTION
|
||||||
|
===========
|
||||||
|
|
||||||
|
:ref:`Watcher Decision Engine <watcher_decision_engine_definition>`
|
||||||
|
|
||||||
|
OPTIONS
|
||||||
|
=======
|
||||||
|
|
||||||
|
**General options**
|
||||||
|
|
||||||
|
.. include:: general-options.rst
|
||||||
|
|
||||||
|
FILES
|
||||||
|
=====
|
||||||
|
|
||||||
|
**/etc/watcher/watcher.conf**
|
||||||
|
Default configuration file for Watcher Decision Engine
|
||||||
|
|
||||||
|
.. include:: footer.rst
|
Loading…
Reference in New Issue
Block a user