From 75fc30090133c31316e6ae790568f1b622807d0c Mon Sep 17 00:00:00 2001 From: Lee Yarwood Date: Fri, 16 Mar 2018 09:37:19 +0000 Subject: [PATCH] docs: Disable smartquotes This change should then allow all configuration examples to be copied from the docs directly into nova.conf without resulting in Unicode errors when these options are then parsed. Note that this option is deprecated and replaced in Sphinx 1.6.6 [1] by the smartquotes configurable. A future change will need to land to switch between these, for now we will use and backport the html_use_smartypants option. [1] http://www.sphinx-doc.org/en/stable/config.html#confval-smartquotes Change-Id: I6c47a0d74e5b5a03bc030a7e45cc7783f22ddadf Closes-bug: #1755783 --- doc/source/conf.py | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/source/conf.py b/doc/source/conf.py index 37cbe24e3b5b..2d5ccc0d77af 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -157,6 +157,10 @@ html_extra_path = ['_extra'] # using the given strftime format. html_last_updated_fmt = '%Y-%m-%d %H:%M' +# Disable smartquotes to ensure all quoted example config options can be copied +# from the docs without later causing unicode errors within Nova. +html_use_smartypants = False + # -- Options for LaTeX output ------------------------------------------------- # Grouping the document tree into LaTeX files. List of tuples