aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorchenxing <chason.chan@foxmail.com>2019-05-29 18:04:03 +0800
committerchenxing <chason.chan@foxmail.com>2019-06-04 17:06:31 +0800
commita02de6732e9bdf0804249159ed72f80273e268bc (patch)
treed690847d3f108ddc2cc5c65b833f8d2458bae863
parent86e9b0831c89352d062bb828e28af33240b94f89 (diff)
downloadkolla-ansible-a02de6732e9bdf0804249159ed72f80273e268bc.tar.gz
kolla-ansible-a02de6732e9bdf0804249159ed72f80273e268bc.zip
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
-rw-r--r--deploy-guide/source/conf.py15
-rw-r--r--doc/requirements.txt5
-rw-r--r--doc/source/conf.py3
-rw-r--r--doc/source/user/quickstart.rst6
4 files changed, 20 insertions, 9 deletions
diff --git a/deploy-guide/source/conf.py b/deploy-guide/source/conf.py
index c9279d8ce..c1a73ce7e 100644
--- a/deploy-guide/source/conf.py
+++ b/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',
+]
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 9fbca52ce..18fa4125a 100644
--- a/doc/requirements.txt
+++ b/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
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 7219f5feb..67fb9971c 100644
--- a/doc/source/conf.py
+++ b/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',
+]
diff --git a/doc/source/user/quickstart.rst b/doc/source/user/quickstart.rst
index 31870cca1..a640c235b 100644
--- a/doc/source/user/quickstart.rst
+++ b/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.
@@ -463,7 +464,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
~~~~~~~~~~