Mostly docs cleanups
Fix documentation build errors and RST formatting
Change-Id: Id93153400c5b069dd9d772381558c7085f64c207
diff --git a/stackrc b/stackrc
index 143298c..c27ead3 100644
--- a/stackrc
+++ b/stackrc
@@ -5,7 +5,7 @@
# Find the other rc files
RC_DIR=$(cd $(dirname "${BASH_SOURCE:-$0}") && pwd)
-# Source required devstack functions and globals
+# Source required DevStack functions and globals
source $RC_DIR/functions
# Destination path for installation
@@ -41,20 +41,20 @@
# enable_service q-dhcp
# enable_service q-l3
# enable_service q-meta
-# # Optional, to enable tempest configuration as part of devstack
+# # Optional, to enable tempest configuration as part of DevStack
# enable_service tempest
-# this allows us to pass ENABLED_SERVICES
+# This allows us to pass ``ENABLED_SERVICES``
if ! isset ENABLED_SERVICES ; then
- # core compute (glance / keystone / nova (+ nova-network))
+ # Compute (Glance / Keystone / Nova (+ nova-network))
ENABLED_SERVICES=g-api,g-reg,key,n-api,n-crt,n-obj,n-cpu,n-net,n-cond,n-sch,n-novnc,n-xvnc,n-cauth
- # cinder
+ # Cinder
ENABLED_SERVICES+=,c-sch,c-api,c-vol
- # heat
+ # Heat
ENABLED_SERVICES+=,h-eng,h-api,h-api-cfn,h-api-cw
- # dashboard
+ # Dashboard
ENABLED_SERVICES+=,horizon
- # additional services
+ # Additional services
ENABLED_SERVICES+=,rabbit,tempest,mysql
fi
@@ -79,7 +79,7 @@
# Tell Tempest which services are available. The default is set here as
# Tempest falls late in the configuration sequence. This differs from
# ``ENABLED_SERVICES`` in that the project names are used here rather than
-# the service names, i.e.: TEMPEST_SERVICES="key,glance,nova"
+# the service names, i.e.: ``TEMPEST_SERVICES="key,glance,nova"``
TEMPEST_SERVICES=""
# Set the default Nova APIs to enable
@@ -145,6 +145,7 @@
# but pass through any extras)
REQUIREMENTS_MODE=${REQUIREMENTS_MODE:-strict}
+
# Repositories
# ------------
@@ -155,16 +156,17 @@
# Which libraries should we install from git instead of using released
# versions on pypi?
#
-# By default devstack is now installing libraries from pypi instead of
+# By default DevStack is now installing libraries from pypi instead of
# from git repositories by default. This works great if you are
# developing server components, but if you want to develop libraries
-# and see them live in devstack you need to tell devstack it should
+# and see them live in DevStack you need to tell DevStack it should
# install them from git.
#
# ex: LIBS_FROM_GIT=python-keystoneclient,oslo.config
#
# Will install those 2 libraries from git, the rest from pypi.
+
##############
#
# OpenStack Server Components
@@ -231,6 +233,7 @@
TROVE_REPO=${TROVE_REPO:-${GIT_BASE}/openstack/trove.git}
TROVE_BRANCH=${TROVE_BRANCH:-master}
+
##############
#
# Testing Components
@@ -306,6 +309,7 @@
# this doesn't exist in a lib file, so set it here
GITDIR["python-openstackclient"]=$DEST/python-openstackclient
+
###################
#
# Oslo Libraries
@@ -396,6 +400,7 @@
GITREPO["pbr"]=${PBR_REPO:-${GIT_BASE}/openstack-dev/pbr.git}
GITBRANCH["pbr"]=${PBR_BRANCH:-master}
+
##################
#
# Libraries managed by OpenStack programs (non oslo)
@@ -453,6 +458,7 @@
ORC_REPO=${ORC_REPO:-${GIT_BASE}/openstack/os-refresh-config.git}
ORC_BRANCH=${ORC_BRANCH:-master}
+
#################
#
# 3rd Party Components (non pip installable)
@@ -474,7 +480,6 @@
SPICE_BRANCH=${SPICE_BRANCH:-master}
-
# Nova hypervisor configuration. We default to libvirt with **kvm** but will
# drop back to **qemu** if we are unable to load the kvm module. ``stack.sh`` can
# also install an **LXC**, **OpenVZ** or **XenAPI** based system. If xenserver-core
@@ -641,7 +646,7 @@
# Set fixed and floating range here so we can make sure not to use addresses
# from either range when attempting to guess the IP to use for the host.
-# Note that setting FIXED_RANGE may be necessary when running DevStack
+# Note that setting ``FIXED_RANGE`` may be necessary when running DevStack
# in an OpenStack cloud that uses either of these address ranges internally.
FLOATING_RANGE=${FLOATING_RANGE:-172.24.4.0/24}
FIXED_RANGE=${FIXED_RANGE:-10.0.0.0/24}
@@ -669,9 +674,10 @@
# Set to 0 to disable shallow cloning
GIT_DEPTH=${GIT_DEPTH:-0}
-# Use native SSL for servers in SSL_ENABLED_SERVICES
+# Use native SSL for servers in ``SSL_ENABLED_SERVICES``
USE_SSL=$(trueorfalse False USE_SSL)
+
# Following entries need to be last items in file
# Compatibility bits required by other callers like Grenade
@@ -693,7 +699,6 @@
# For compat, if SCREEN_LOGDIR is set, it will be used to create back-compat symlinks to the LOGDIR
# symlinks to SCREEN_LOGDIR (compat)
-
# Set up new logging defaults
if [[ -z "${LOGDIR:-}" ]]; then
default_logdir=$DEST/logs
@@ -718,8 +723,8 @@
unset default_logdir logfile
fi
-# LOGDIR is always set at this point so it is not useful as a 'enable' for service logs
-# SCREEN_LOGDIR may be set, it is useful to enable the compat symlinks
+# ``LOGDIR`` is always set at this point so it is not useful as a 'enable' for service logs
+# ``SCREEN_LOGDIR`` may be set, it is useful to enable the compat symlinks
# Local variables:
# mode: shell-script