summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndreas Jaeger <aj@suse.com>2020-05-18 21:17:52 +0200
committerAndreas Jaeger <aj@suse.com>2020-06-09 07:54:54 +0200
commitea2e6420934b4ae45d28773fbf0c65ec21128c41 (patch)
treec76634056ef7172942d0d6c0d08843da99863cca
parent69a14917e5f98f82dd1f4cdf33a49e6f3f708c13 (diff)
downloadpython-barbicanclient-ea2e6420934b4ae45d28773fbf0c65ec21128c41.tar.gz
Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.0 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. 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. 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. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: Iec58d8dfa90b9b3d7b67d81798b32fb2670e21d4
-rw-r--r--doc/requirements.txt5
-rwxr-xr-xdoc/source/conf.py9
2 files changed, 8 insertions, 6 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 72f239e..7d57dad 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,6 +1,7 @@
# The order of packages is significant, because pip processes them in the order
# of appearance. Changing the order has an impact on the overall integration
# process, which may cause wedges in the gate later.
-sphinx>=1.8.0,!=2.1.0 # BSD
+
+sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-svg2pdfconverter>=0.1.0 # BSD
-openstackdocstheme>=1.20.0 # Apache-2.0
+openstackdocstheme>=2.2.1 # Apache-2.0
diff --git a/doc/source/conf.py b/doc/source/conf.py
index 0547331..7579242 100755
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -48,7 +48,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 --------------------------------------------------
@@ -79,6 +79,7 @@ latex_use_xindy = False
#intersphinx_mapping = {'http://docs.python.org/': None}
# -- Options for openstackdocstheme -------------------------------------------
-repository_name = 'openstack/python-barbicanclient'
-bug_project = 'python-barbicanclient'
-bug_tag = ''
+openstackdocs_repo_name = 'openstack/python-barbicanclient'
+openstackdocs_pdf_link = True
+openstackdocs_bug_project = 'python-barbicanclient'
+openstackdocs_bug_tag = ''