aboutsummaryrefslogtreecommitdiff
path: root/doc/source/conf.py
diff options
context:
space:
mode:
authorjacky06 <zhang.min@99cloud.net>2020-05-21 00:06:55 +0800
committerAndreas Jaeger <aj@suse.com>2020-06-06 15:24:31 +0200
commit47b51081a5eadaa6cd91afc02e1f1345acaa7465 (patch)
tree2b1ff34c8e1768cdb2bf5383af752fa27e00ac99 /doc/source/conf.py
parent1ebb97c9f266e9be222d53d423031c75b2eb3ea4 (diff)
downloadkolla-47b51081a5eadaa6cd91afc02e1f1345acaa7465.tar.gz
kolla-47b51081a5eadaa6cd91afc02e1f1345acaa7465.zip
Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * Allow parallel building of documents Update Sphinx version as well. Remove docs requirements from lower-constraints, they are not needed during install or test but only for docs building. openstackdocstheme renames some variables, so follow the renames before the next release removes them. A couple of variables are also not needed anymore, remove them. Set openstackdocs_pdf_link to link to PDF file. Note that the link to the published document only works on docs.openstack.org where the PDF file is placed in the top-level html directory. The site-preview places the PDF in a pdf directory. Set openstackdocs_auto_name to use 'project' as name. Change-Id: I138d51ace230a434e76fbe9fbbe97e53212230f3
Diffstat (limited to 'doc/source/conf.py')
-rw-r--r--doc/source/conf.py21
1 files changed, 4 insertions, 17 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index fbde9778e..5616d7a57 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -40,17 +40,6 @@ master_doc = 'index'
project = u'kolla'
copyright = u'2013-present, OpenStack Foundation'
-# 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.
-from kolla.version import version_info as kolla_version
-# The full version, including alpha/beta/rc tags.
-release = kolla_version.version_string_with_vcs()
-# The short X.Y version.
-version = kolla_version.canonical_version_string()
-
# If true, '()' will be appended to :func: etc. cross-reference text.
add_function_parentheses = True
@@ -76,9 +65,6 @@ html_theme_options = {
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project
-# Must set this variable to include year, month, day, hours, and minutes.
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
-
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass
# [howto/manual]).
@@ -93,9 +79,10 @@ latex_documents = [
latex_use_xindy = False
# openstackdocstheme options
-repository_name = 'openstack/kolla'
-bug_project = 'kolla'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/kolla'
+openstackdocs_pdf_link = True
+openstackdocs_bug_project = 'kolla'
+openstackdocs_bug_tag = ''
openstack_projects = [
'kolla-ansible',
'oslotest',