Fix the deploy guide build failed

Depends-On: https://review.opendev.org/662209
Co-authored-by: Stephen Finucane <stephenfin@redhat.com>
Closes-Bug: #1830586
Change-Id: I48d3f4c5f7c04b1ab41b3bad2a6c19e1e9a218fd
This commit is contained in:
chenxing 2019-05-29 18:04:03 +08:00 committed by Mark Goddard
parent 615028f354
commit 261de9e33f
4 changed files with 20 additions and 9 deletions

View File

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

View File

@ -5,6 +5,7 @@
# changes how packages are installed. New dependencies should be # changes how packages are installed. New dependencies should be
# added in alphabetical order, however, some dependencies may need to # added in alphabetical order, however, some dependencies may need to
# be installed in a specific order. # 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 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

View File

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

View File

@ -31,7 +31,8 @@ run with root privileges.
It is generally recommended to use a virtual environment to install Kolla It is generally recommended to use a virtual environment to install Kolla
Ansible and its dependencies, to avoid conflicts with the system site packages. 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 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. #. For CentOS, install EPEL.
@ -463,7 +464,8 @@ There are a few options that are required to deploy Kolla-Ansible:
* Virtual environment * Virtual environment
It is recommended to use a virtual environment to execute tasks on the remote 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 Deployment
~~~~~~~~~~ ~~~~~~~~~~