openstack
/
nova
Code Issues Proposed changes

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
This commit is contained in:
Lee Yarwood 2018-03-16 09:37:19 +00:00
parent ea12e34724
commit 75fc300901
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/source/conf.py
View File

@ -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