c4777794e7
Here are some skeletons for the documentation which will need to be written.
doc/source
A Sphinx based document which will be aimed at heat developers.
This also contains .rst files which generate the man files
doc/docbkx/api-ref
Docbook and WADL for the REST API, with the intent of moving this
to api-site to publish to api.openstack.org
doc/docbkx/heat-admin
Docbook manual targeted at Heat admins, with the intent of moving this
to openstack-manuals to publish to docs.openstack.org
doc/docbkx/heat-cli
Docbook manual targeted at users of the Heat CLI, with the intent of
moving this to openstack-manuals to publish to docs.openstack.org
Dude, wheres my man pages?
docs/man
is deleted, now generated into doc/build/man
Packaging will need to be updated to generate the man pages
Change-Id: Idf2f37086b6f97df18ed57172de2f9e3d4c7706a
40 lines
945 B
ReStructuredText
40 lines
945 B
ReStructuredText
========
|
|
heat-api
|
|
========
|
|
|
|
.. program:: heat-api
|
|
|
|
SYNOPSIS
|
|
========
|
|
``heat-api [options]``
|
|
|
|
DESCRIPTION
|
|
===========
|
|
heat-api provides an external REST API to the heat project.
|
|
|
|
INVENTORY
|
|
=========
|
|
heat-api is a service that exposes an external REST based api to the
|
|
heat-engine service. The communication between the heat-api
|
|
heat-engine uses message queue based RPC.
|
|
|
|
OPTIONS
|
|
=======
|
|
.. cmdoption:: --config-file
|
|
|
|
Path to a config file to use. Multiple config files can be specified, with
|
|
values in later files taking precedence.
|
|
|
|
|
|
.. cmdoption:: --config-dir
|
|
|
|
Path to a config directory to pull .conf files from. This file set is
|
|
sorted, so as to provide a predictable parse order if individual options are
|
|
over-ridden. The set is parsed after the file(s), if any, specified via
|
|
--config-file, hence over-ridden options in the directory take precedence.
|
|
|
|
FILES
|
|
========
|
|
|
|
* /etc/heat/heat-api.conf
|
|
* /etc/heat/heat-api-paste.ini |