diff --git a/doc/source/deploy/apache-mod-wsgi.rst b/doc/source/admin/apache-mod-wsgi.rst similarity index 100% rename from doc/source/deploy/apache-mod-wsgi.rst rename to doc/source/admin/apache-mod-wsgi.rst diff --git a/doc/source/deploy/conf-files.rst b/doc/source/admin/conf-files.rst similarity index 100% rename from doc/source/deploy/conf-files.rst rename to doc/source/admin/conf-files.rst diff --git a/doc/source/deploy/configuration.rst b/doc/source/admin/configuration.rst similarity index 100% rename from doc/source/deploy/configuration.rst rename to doc/source/admin/configuration.rst diff --git a/doc/source/deploy/gmr.rst b/doc/source/admin/gmr.rst similarity index 100% rename from doc/source/deploy/gmr.rst rename to doc/source/admin/gmr.rst diff --git a/doc/source/admin/index.rst b/doc/source/admin/index.rst new file mode 100644 index 0000000..a29aa87 --- /dev/null +++ b/doc/source/admin/index.rst @@ -0,0 +1,10 @@ +.. toctree:: + :maxdepth: 2 + + apache-mod-wsgi + conf-files + configuration + gmr + policy + ways-to-install + ../strategies/index diff --git a/doc/source/deploy/policy.rst b/doc/source/admin/policy.rst similarity index 100% rename from doc/source/deploy/policy.rst rename to doc/source/admin/policy.rst diff --git a/doc/source/deploy/installation.rst b/doc/source/admin/ways-to-install.rst similarity index 94% rename from doc/source/deploy/installation.rst rename to doc/source/admin/ways-to-install.rst index 392efca..43bd888 100644 --- a/doc/source/deploy/installation.rst +++ b/doc/source/admin/ways-to-install.rst @@ -4,12 +4,13 @@ https://creativecommons.org/licenses/by/3.0/ -================== -Installing Watcher -================== +======================= +Ways to install Watcher +======================= -This document describes how to install Watcher in order to use it. If you are -intending to develop on or with Watcher, please read :doc:`../dev/environment`. +This document describes some ways to install Watcher in order to use it. +If you are intending to develop on or with Watcher, +please read :doc:`../dev/environment`. Prerequisites ------------- diff --git a/doc/source/dev/contributing.rst b/doc/source/contributor/contributing.rst similarity index 100% rename from doc/source/dev/contributing.rst rename to doc/source/contributor/contributing.rst diff --git a/doc/source/dev/devstack.rst b/doc/source/contributor/devstack.rst similarity index 100% rename from doc/source/dev/devstack.rst rename to doc/source/contributor/devstack.rst diff --git a/doc/source/dev/environment.rst b/doc/source/contributor/environment.rst similarity index 100% rename from doc/source/dev/environment.rst rename to doc/source/contributor/environment.rst diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000..eddf972 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,8 @@ +.. toctree:: + :maxdepth: 1 + + environment + devstack + notifications + testing + rally_link diff --git a/doc/source/dev/notifications.rst b/doc/source/contributor/notifications.rst similarity index 100% rename from doc/source/dev/notifications.rst rename to doc/source/contributor/notifications.rst diff --git a/doc/source/dev/plugin/action-plugin.rst b/doc/source/contributor/plugin/action-plugin.rst similarity index 100% rename from doc/source/dev/plugin/action-plugin.rst rename to doc/source/contributor/plugin/action-plugin.rst diff --git a/doc/source/dev/plugin/base-setup.rst b/doc/source/contributor/plugin/base-setup.rst similarity index 100% rename from doc/source/dev/plugin/base-setup.rst rename to doc/source/contributor/plugin/base-setup.rst diff --git a/doc/source/dev/plugin/cdmc-plugin.rst b/doc/source/contributor/plugin/cdmc-plugin.rst similarity index 100% rename from doc/source/dev/plugin/cdmc-plugin.rst rename to doc/source/contributor/plugin/cdmc-plugin.rst diff --git a/doc/source/dev/plugin/goal-plugin.rst b/doc/source/contributor/plugin/goal-plugin.rst similarity index 100% rename from doc/source/dev/plugin/goal-plugin.rst rename to doc/source/contributor/plugin/goal-plugin.rst diff --git a/doc/source/contributor/plugin/index.rst b/doc/source/contributor/plugin/index.rst new file mode 100644 index 0000000..4fedb01 --- /dev/null +++ b/doc/source/contributor/plugin/index.rst @@ -0,0 +1,11 @@ +.. toctree:: + :maxdepth: 1 + + base-setup + action-plugin + cdmc-plugin + goal-plugin + planner-plugin + scoring-engine-plugin + strategy-plugin + plugins diff --git a/doc/source/dev/plugin/planner-plugin.rst b/doc/source/contributor/plugin/planner-plugin.rst similarity index 100% rename from doc/source/dev/plugin/planner-plugin.rst rename to doc/source/contributor/plugin/planner-plugin.rst diff --git a/doc/source/dev/plugins.rst b/doc/source/contributor/plugin/plugins.rst similarity index 100% rename from doc/source/dev/plugins.rst rename to doc/source/contributor/plugin/plugins.rst diff --git a/doc/source/dev/plugin/scoring-engine-plugin.rst b/doc/source/contributor/plugin/scoring-engine-plugin.rst similarity index 100% rename from doc/source/dev/plugin/scoring-engine-plugin.rst rename to doc/source/contributor/plugin/scoring-engine-plugin.rst diff --git a/doc/source/dev/plugin/strategy-plugin.rst b/doc/source/contributor/plugin/strategy-plugin.rst similarity index 100% rename from doc/source/dev/plugin/strategy-plugin.rst rename to doc/source/contributor/plugin/strategy-plugin.rst diff --git a/doc/source/dev/rally_link.rst b/doc/source/contributor/rally_link.rst similarity index 100% rename from doc/source/dev/rally_link.rst rename to doc/source/contributor/rally_link.rst diff --git a/doc/source/dev/testing.rst b/doc/source/contributor/testing.rst similarity index 100% rename from doc/source/dev/testing.rst rename to doc/source/contributor/testing.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index 0cae341..2fe238d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -43,7 +43,7 @@ Introduction glossary architecture - dev/contributing + contributor/contributing Getting Started @@ -52,14 +52,14 @@ Getting Started .. toctree:: :maxdepth: 1 - dev/environment - dev/devstack - deploy/configuration - deploy/conf-files - deploy/apache-mod-wsgi - dev/notifications - dev/testing - dev/rally_link + contributor/index + +Installation +------------ +.. toctree:: + :maxdepth: 2 + + install/index API References -------------- @@ -67,7 +67,7 @@ API References .. toctree:: :maxdepth: 1 - webapi/v1 + webapi/index Plugins ------- @@ -75,30 +75,23 @@ Plugins .. toctree:: :maxdepth: 1 - dev/plugin/base-setup - dev/plugin/goal-plugin - dev/plugin/scoring-engine-plugin - dev/plugin/strategy-plugin - dev/plugin/cdmc-plugin - dev/plugin/action-plugin - dev/plugin/planner-plugin - dev/plugins - + contributor/plugin/index Admin Guide =========== -Introduction ------------- - .. toctree:: :maxdepth: 1 - deploy/installation - deploy/user-guide - deploy/policy - deploy/gmr - strategies/strategies + admin/index + +User Guide +========== + +.. toctree:: + :maxdepth: 2 + + user/index Watcher Manual Pages ==================== @@ -107,7 +100,7 @@ Watcher Manual Pages :glob: :maxdepth: 1 - man/* + man/index .. # 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 diff --git a/install-guide/source/common_configure.rst b/doc/source/install/common_configure.rst similarity index 100% rename from install-guide/source/common_configure.rst rename to doc/source/install/common_configure.rst diff --git a/install-guide/source/common_prerequisites.rst b/doc/source/install/common_prerequisites.rst similarity index 98% rename from install-guide/source/common_prerequisites.rst rename to doc/source/install/common_prerequisites.rst index fda84d0..c367894 100644 --- a/install-guide/source/common_prerequisites.rst +++ b/doc/source/install/common_prerequisites.rst @@ -15,13 +15,13 @@ you must create a database, service credentials, and API endpoints. * Create the ``watcher`` database: - .. code-block:: none + .. code-block:: console CREATE DATABASE watcher CHARACTER SET utf8; * Grant proper access to the ``watcher`` database: - .. code-block:: none + .. code-block:: console GRANT ALL PRIVILEGES ON watcher.* TO 'watcher'@'localhost' \ IDENTIFIED BY 'WATCHER_DBPASS'; @@ -32,7 +32,7 @@ you must create a database, service credentials, and API endpoints. * Exit the database access client. - .. code-block:: none + .. code-block:: console exit; diff --git a/install-guide/source/get_started.rst b/doc/source/install/get_started.rst similarity index 100% rename from install-guide/source/get_started.rst rename to doc/source/install/get_started.rst diff --git a/install-guide/source/index.rst b/doc/source/install/index.rst similarity index 88% rename from install-guide/source/index.rst rename to doc/source/install/index.rst index 7c9aa73..54fff98 100644 --- a/install-guide/source/index.rst +++ b/doc/source/install/index.rst @@ -23,14 +23,14 @@ of data center operating costs, increased system performance via intelligent virtual machine migration, increased energy efficiency—and more! -watcher also supports a pluggable architecture by which custom +Watcher also supports a pluggable architecture by which custom optimization algorithms, data metrics and data profilers can be developed and inserted into the Watcher framework. -check the documentation for watcher optimization strategies at +Check the documentation for watcher optimization strategies at https://docs.openstack.org/developer/watcher/strategies -check watcher glossary at +Check watcher glossary at https://docs.openstack.org/developer/watcher/glossary.html diff --git a/install-guide/source/install-obs.rst b/doc/source/install/install-obs.rst similarity index 88% rename from install-guide/source/install-obs.rst rename to doc/source/install/install-obs.rst index 4805c15..6b3a48a 100644 --- a/install-guide/source/install-obs.rst +++ b/doc/source/install/install-obs.rst @@ -4,8 +4,9 @@ Install and configure for openSUSE and SUSE Linux Enterprise ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This section describes how to install and configure the Infrastructure Optimization service -for openSUSE Leap 42.1 and SUSE Linux Enterprise Server 12 SP1. +This section describes how to install and configure the Infrastructure +Optimization service for openSUSE Leap 42.1 and +SUSE Linux Enterprise Server 12 SP1. .. include:: common_prerequisites.rst diff --git a/install-guide/source/install-rdo.rst b/doc/source/install/install-rdo.rst similarity index 93% rename from install-guide/source/install-rdo.rst rename to doc/source/install/install-rdo.rst index 9215be9..47105d9 100644 --- a/install-guide/source/install-rdo.rst +++ b/doc/source/install/install-rdo.rst @@ -4,8 +4,8 @@ Install and configure for Red Hat Enterprise Linux and CentOS ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This section describes how to install and configure the Infrastructure Optimization service -for Red Hat Enterprise Linux 7 and CentOS 7. +This section describes how to install and configure the Infrastructure +Optimization service for Red Hat Enterprise Linux 7 and CentOS 7. .. include:: common_prerequisites.rst diff --git a/install-guide/source/install-ubuntu.rst b/doc/source/install/install-ubuntu.rst similarity index 93% rename from install-guide/source/install-ubuntu.rst rename to doc/source/install/install-ubuntu.rst index e913b8a..e475a89 100644 --- a/install-guide/source/install-ubuntu.rst +++ b/doc/source/install/install-ubuntu.rst @@ -3,8 +3,8 @@ Install and configure for Ubuntu ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -This section describes how to install and configure the Infrastructure Optimization -service for Ubuntu 14.04 (LTS). +This section describes how to install and configure the Infrastructure +Optimization service for Ubuntu 14.04 (LTS). .. include:: common_prerequisites.rst diff --git a/install-guide/source/install.rst b/doc/source/install/install.rst similarity index 74% rename from install-guide/source/install.rst rename to doc/source/install/install.rst index a235f9c..e6c8883 100644 --- a/install-guide/source/install.rst +++ b/doc/source/install/install.rst @@ -3,8 +3,8 @@ Install and configure ~~~~~~~~~~~~~~~~~~~~~ -This section describes how to install and configure the -Infrastructure Optimization service, code-named watcher, on the controller node. +This section describes how to install and configure the Infrastructure +Optimization service, code-named watcher, on the controller node. This section assumes that you already have a working OpenStack environment with at least the following components installed: diff --git a/install-guide/source/next-steps.rst b/doc/source/install/next-steps.rst similarity index 100% rename from install-guide/source/next-steps.rst rename to doc/source/install/next-steps.rst diff --git a/install-guide/source/verify.rst b/doc/source/install/verify.rst similarity index 100% rename from install-guide/source/verify.rst rename to doc/source/install/verify.rst diff --git a/doc/source/man/index.rst b/doc/source/man/index.rst new file mode 100644 index 0000000..74469af --- /dev/null +++ b/doc/source/man/index.rst @@ -0,0 +1,10 @@ +.. toctree:: + :glob: + :maxdepth: 1 + + footer.rst + general-options + watcher-api + watcher-applier + watcher-db-manage + watcher-decision-engine \ No newline at end of file diff --git a/doc/source/strategies/basic-server-consolidation.rst b/doc/source/strategies/basic-server-consolidation.rst index 5d476c2..ef8bea1 100644 --- a/doc/source/strategies/basic-server-consolidation.rst +++ b/doc/source/strategies/basic-server-consolidation.rst @@ -57,7 +57,7 @@ Planner Default Watcher's planner: - .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner + .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner Configuration ------------- diff --git a/doc/source/strategies/strategies.rst b/doc/source/strategies/index.rst similarity index 100% rename from doc/source/strategies/strategies.rst rename to doc/source/strategies/index.rst diff --git a/doc/source/strategies/outlet_temp_control.rst b/doc/source/strategies/outlet_temp_control.rst index cbd4a41..5a4294c 100644 --- a/doc/source/strategies/outlet_temp_control.rst +++ b/doc/source/strategies/outlet_temp_control.rst @@ -61,7 +61,7 @@ Planner Default Watcher's planner: - .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner + .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner Configuration ------------- diff --git a/doc/source/strategies/uniform_airflow.rst b/doc/source/strategies/uniform_airflow.rst index 1801e85..d31f631 100644 --- a/doc/source/strategies/uniform_airflow.rst +++ b/doc/source/strategies/uniform_airflow.rst @@ -59,7 +59,7 @@ Planner Default Watcher's planner: - .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner + .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner Configuration ------------- diff --git a/doc/source/strategies/vm_workload_consolidation.rst b/doc/source/strategies/vm_workload_consolidation.rst index b0dc0d6..5d30f9d 100644 --- a/doc/source/strategies/vm_workload_consolidation.rst +++ b/doc/source/strategies/vm_workload_consolidation.rst @@ -67,7 +67,7 @@ Planner Default Watcher's planner: - .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner + .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner Configuration diff --git a/doc/source/strategies/workload-stabilization.rst b/doc/source/strategies/workload-stabilization.rst index c3eafec..567aa1d 100644 --- a/doc/source/strategies/workload-stabilization.rst +++ b/doc/source/strategies/workload-stabilization.rst @@ -58,7 +58,7 @@ Planner Default Watcher's planner: - .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner + .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner Configuration ------------- diff --git a/doc/source/strategies/workload_balance.rst b/doc/source/strategies/workload_balance.rst index 36dcc5a..ea09c6e 100644 --- a/doc/source/strategies/workload_balance.rst +++ b/doc/source/strategies/workload_balance.rst @@ -56,7 +56,7 @@ Planner Default Watcher's planner: - .. watcher-term:: watcher.decision_engine.planner.default.DefaultPlanner + .. watcher-term:: watcher.decision_engine.planner.weight.WeightPlanner Configuration ------------- diff --git a/doc/source/user/index.rst b/doc/source/user/index.rst new file mode 100644 index 0000000..bb1db2c --- /dev/null +++ b/doc/source/user/index.rst @@ -0,0 +1,4 @@ +.. toctree:: + :maxdepth: 2 + + user-guide diff --git a/doc/source/deploy/user-guide.rst b/doc/source/user/user-guide.rst similarity index 100% rename from doc/source/deploy/user-guide.rst rename to doc/source/user/user-guide.rst diff --git a/doc/source/webapi/index.rst b/doc/source/webapi/index.rst new file mode 100644 index 0000000..fd0ecfd --- /dev/null +++ b/doc/source/webapi/index.rst @@ -0,0 +1,4 @@ +.. toctree:: + :maxdepth: 1 + + v1 diff --git a/doc/source/webapi/v1.rst b/doc/source/webapi/v1.rst index 086cf08..b702137 100644 --- a/doc/source/webapi/v1.rst +++ b/doc/source/webapi/v1.rst @@ -20,6 +20,17 @@ Goals .. autotype:: watcher.api.controllers.v1.goal.Goal :members: +Strategies +========== + +.. rest-controller:: watcher.api.controllers.v1.strategy:StrategiesController + :webprefix: /v1/strategies + +.. autotype:: watcher.api.controllers.v1.strategy.StrategyCollection + :members: + +.. autotype:: watcher.api.controllers.v1.strategy.Strategy + :members: Audit Templates =============== diff --git a/install-guide/source/conf.py b/install-guide/source/conf.py deleted file mode 100644 index 01b0eb5..0000000 --- a/install-guide/source/conf.py +++ /dev/null @@ -1,301 +0,0 @@ -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or -# implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import os -# import sys - - -import openstackdocstheme - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# sys.path.insert(0, os.path.abspath('.')) - -# -- General configuration ------------------------------------------------ - -# If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' - -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. -# TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder' -# extensions = - -# Add any paths that contain templates here, relative to this directory. -# templates_path = ['_templates'] - -# The suffix of source filenames. -source_suffix = '.rst' - -# The encoding of source files. -# source_encoding = 'utf-8-sig' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -project = u'Installation Guide for Infrastructure Optimization Service' -bug_tag = u'install-guide' -copyright = u'2016, OpenStack contributors' - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = '0.1' -# The full version, including alpha/beta/rc tags. -release = '0.1' - -# A few variables have to be set for the log-a-bug feature. -# giturl: The location of conf.py on Git. Must be set manually. -# gitsha: The SHA checksum of the bug description. Automatically extracted -# from git log. -# bug_tag: Tag for categorizing the bug. Must be set manually. -# These variables are passed to the logabug code via html_context. -giturl = u'http://git.openstack.org/cgit/openstack/watcher/tree/install-guide/source' # noqa -git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" -gitsha = os.popen(git_cmd).read().strip('\n') -html_context = {"gitsha": gitsha, "bug_tag": bug_tag, - "giturl": giturl, - "bug_project": "watcher"} - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# language = None - -# There are two options for replacing |today|: either, you set today to some -# non-false value, then it is used: -# today = '' -# Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -exclude_patterns = ["common_prerequisites.rst", "common_configure.rst"] - -# The reST default role (used for this markup: `text`) to use for all -# documents. -# default_role = None - -# If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -# add_module_names = True - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -# show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# A list of ignored prefixes for module index sorting. -# modindex_common_prefix = [] - -# If true, keep warnings as "system message" paragraphs in the built documents. -# keep_warnings = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -html_theme = 'openstackdocs' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# html_theme_options = {} - -# Add any paths that contain custom themes here, relative to this directory. -html_theme_path = [openstackdocstheme.get_html_theme_path()] - -# The name for this set of Sphinx documents. If None, it defaults to -# " v documentation". -# html_title = None - -# A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None - -# The name of an image file (relative to this directory) to place at the top -# of the sidebar. -# html_logo = None - -# The name of an image file (within the static path) to use as favicon of the -# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 -# pixels large. -# html_favicon = None - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -# html_static_path = [] - -# Add any extra paths that contain custom files (such as robots.txt or -# .htaccess) here, relative to this directory. These files are copied -# directly to the root of the documentation. -# html_extra_path = [] - -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# So that we can enable "log-a-bug" links from each output HTML page, this -# variable must be set to a format that includes year, month, day, hours and -# minutes. -html_last_updated_fmt = '%Y-%m-%d %H:%M' - - -# If true, SmartyPants will be used to convert quotes and dashes to -# typographically correct entities. -# html_use_smartypants = True - -# Custom sidebar templates, maps document names to template names. -# html_sidebars = {} - -# Additional templates that should be rendered to pages, maps page names to -# template names. -# html_additional_pages = {} - -# If false, no module index is generated. -# html_domain_indices = True - -# If false, no index is generated. -html_use_index = False - -# If true, the index is split into individual pages for each letter. -# html_split_index = False - -# If true, links to the reST sources are added to the pages. -html_show_sourcelink = False - -# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True - -# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True - -# If true, an OpenSearch description file will be output, and all pages will -# contain a tag referring to it. The value of this option must be the -# base URL from which the finished HTML is served. -# html_use_opensearch = '' - -# This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None - -# Output file base name for HTML help builder. -htmlhelp_basename = 'install-guide' - -# If true, publish source files -html_copy_source = False - -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # 'preamble': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ('index', 'InstallGuide.tex', u'Install Guide', - u'OpenStack contributors', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [ - ('index', 'installguide', u'Install Guide', - [u'OpenStack contributors'], 1) -] - -# If true, show URL addresses after external links. -# man_show_urls = False - - -# -- Options for Texinfo output ------------------------------------------- - -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ('index', 'InstallGuide', u'Install Guide', - u'OpenStack contributors', 'InstallGuide', - 'This guide shows OpenStack end users how to install ' - 'an OpenStack cloud.', 'Miscellaneous'), -] - -# Documents to append as an appendix to all manuals. -# texinfo_appendices = [] - -# If false, no module index is generated. -# texinfo_domain_indices = True - -# How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' - -# If true, do not generate a @detailmenu in the "Top" node's menu. -# texinfo_no_detailmenu = False - -# -- Options for Internationalization output ------------------------------ -locale_dirs = ['locale/'] - -# -- Options for PDF output -------------------------------------------------- - -pdf_documents = [ - ('index', u'InstallGuide', u'Install Guide', - u'OpenStack contributors') -]