c8096c6148
'Module Index' link points to HTML doc generated from source/api RST files. These RST files are generated by pbr, by setting the parameter 'autodoc_index_modules' to True. Partial-Bug: #1535244 Change-Id: Ifceb5a140599d3968ea3d353b12c0bbe99d955e6
90 lines
1.6 KiB
ReStructuredText
90 lines
1.6 KiB
ReStructuredText
..
|
|
Except where otherwise noted, this document is licensed under Creative
|
|
Commons Attribution 3.0 License. You can view the license at:
|
|
|
|
https://creativecommons.org/licenses/by/3.0/
|
|
|
|
============================================
|
|
Welcome to Watcher's developer documentation
|
|
============================================
|
|
|
|
.. include:: ../../README.rst
|
|
|
|
The developer documentation provided here is continually kept up-to-date based
|
|
on the latest code, and may not represent the state of the project at any
|
|
specific prior release.
|
|
|
|
Developer Guide
|
|
===============
|
|
|
|
Introduction
|
|
------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
glossary
|
|
architecture
|
|
deploy/configuration
|
|
dev/environment
|
|
dev/contributing
|
|
dev/plugins
|
|
|
|
|
|
DevStack Plugin
|
|
---------------
|
|
|
|
You can configure DevStack to set up the Watcher services easily using
|
|
Watcher's DevStack plugin.
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
dev/devstack-plugin
|
|
|
|
API References
|
|
--------------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
webapi/v1
|
|
|
|
Admin Guide
|
|
===========
|
|
|
|
Overview
|
|
--------
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
deploy/user-guide
|
|
deploy/installation
|
|
|
|
Watcher Manual Pages
|
|
====================
|
|
|
|
.. toctree::
|
|
:glob:
|
|
:maxdepth: 1
|
|
|
|
man/*
|
|
|
|
.. # NOTE(mriedem): This is the section where we hide things that we don't
|
|
# actually want in the table of contents but sphinx build would fail if
|
|
# they aren't in the toctree somewhere. For example, we hide api/autoindex
|
|
# since that's already covered with modindex below.
|
|
.. toctree::
|
|
:hidden:
|
|
|
|
api/autoindex
|
|
|
|
|
|
Indices and tables
|
|
==================
|
|
|
|
* :ref:`genindex`
|
|
* :ref:`modindex`
|
|
* :ref:`search`
|