summaryrefslogtreecommitdiff
path: root/doc/source/conf.py
diff options
context:
space:
mode:
authorAndreas Jaeger <aj@suse.com>2020-05-31 20:34:11 +0200
committerAndreas Jaeger <aj@suse.com>2020-05-31 20:37:45 +0200
commit82a708b09f944708a770e8c5ffae5ea98848ed46 (patch)
treed462cf2f11eaecc80c0b109ba119b181acdd1ade /doc/source/conf.py
parentaa10eb7bcbb96d78ac923735db0753472ee059a3 (diff)
downloados-client-config-82a708b09f944708a770e8c5ffae5ea98848ed46.tar.gz
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 * Fix some rendering problems Update Sphinx version as well. Disable openstackdocs_auto_name to use 'project' variable as name. Change pygments_style to 'native' since old theme version always used 'native' and the theme now respects the setting and using 'sphinx' can lead to some strange rendering. 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. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I9b21866eee164c1c14d0e4333e842bd6fefcb820
Diffstat (limited to 'doc/source/conf.py')
-rwxr-xr-xdoc/source/conf.py12
1 files changed, 4 insertions, 8 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py
index cbd9888..69304fc 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -15,8 +15,6 @@
import os
import sys
-import openstackdocstheme
-
sys.path.insert(0, os.path.abspath('../..'))
# -- General configuration ----------------------------------------------------
@@ -30,10 +28,9 @@ extensions = [
]
# openstackdocstheme options
-repository_name = 'openstack/os-client-config'
-bug_project = 'os-client-config'
-bug_tag = ''
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
+openstackdocs_repo_name = 'openstack/os-client-config'
+openstackdocs_auto_name = False
+openstackdocs_use_storyboard = True
# autodoc generation is a bit aggressive and a nuisance when doing heavy
# text edit cycles.
@@ -57,7 +54,7 @@ add_function_parentheses = True
add_module_names = True
# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
# -- Options for HTML output --------------------------------------------------
@@ -67,7 +64,6 @@ pygments_style = 'sphinx'
# html_theme = '_theme'
# html_static_path = ['static']
html_theme = 'openstackdocs'
-html_theme_path = [openstackdocstheme.get_html_theme_path()]
# Output file base name for HTML help builder.
htmlhelp_basename = '%sdoc' % project