Merge "Fix the deploy guide build failed"

deploy-guide/source/conf.py

@@ -23,9 +23,6 @@
 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.
@@ -40,7 +37,9 @@ import openstackdocstheme
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 # TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder'
-# extensions =
+extensions = [
+    'openstackdocstheme',
+]
 
 # Add any paths that contain templates here, relative to this directory.
 # templates_path = ['_templates']
@@ -129,7 +128,7 @@ html_theme = 'openstackdocs'
 # html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-html_theme_path = [openstackdocstheme.get_html_theme_path()]
+# html_theme_path = [openstackdocstheme.get_html_theme_path()]
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
@@ -296,3 +295,9 @@ pdf_documents = [
     ('index', u'DeployGuide', u'Deploy Guide',
      u'OpenStack contributors')
 ]
+
+# -- Options for openstackdocstheme -------------------------------------------
+
+openstack_projects = [
+    'kolla-ansible',
+]

doc/requirements.txt

@@ -5,6 +5,7 @@
 # changes how packages are installed.  New dependencies should be
 # added in alphabetical order, however, some dependencies may need to
 # be installed in a specific order.
-openstackdocstheme>=1.18.1 # Apache-2.0
+openstackdocstheme>=1.19.0 # Apache-2.0
 reno>=2.5.0 # Apache-2.0
-sphinx!=1.6.6,>=1.6.2 # BSD
+sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD
+sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4'  # BSD

doc/source/conf.py

@@ -88,3 +88,6 @@ latex_documents = [
 repository_name = 'openstack/kolla-ansible'
 bug_project = 'kolla-ansible'
 bug_tag = ''
+openstack_projects = [
+    'kolla-ansible',
+]

doc/source/user/quickstart.rst

@@ -31,7 +31,8 @@ run with root privileges.
 It is generally recommended to use a virtual environment to install Kolla
 Ansible and its dependencies, to avoid conflicts with the system site packages.
 Note that this is independent from the use of a virtual environment for remote
-execution, which is described :ref:`here <virtual-environments-target-hosts>`.
+execution, which is described in
+:kolla-ansible-doc:`Virtual Environments <user/virtual-environments.html>`.
 
 #. For CentOS, install EPEL.
 
@@ -475,7 +476,8 @@ There are a few options that are required to deploy Kolla-Ansible:
 * Virtual environment
 
   It is recommended to use a virtual environment to execute tasks on the remote
-  hosts.  This is covered :ref:`here <virtual-environments-target-hosts>`.
+  hosts.  This is covered
+  :kolla-ansible-doc:`Virtual Environments <user/virtual-environments.html>`.
 
 Deployment
 ~~~~~~~~~~