summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorAndreas Jaeger <aj@suse.com>2020-05-18 21:45:15 +0200
committerAndreas Jaeger <jaegerandi@gmail.com>2020-05-22 17:20:37 +0000
commit3fa304428c8837174d045bb271a397346e66a3d8 (patch)
tree63e164b71008b8d803ad315afdeaf26620aa2db3 /doc
parentc588de46247a12606c775ee9942ff793d06e96af (diff)
downloadpython-heatclient-3fa304428c8837174d045bb271a397346e66a3d8.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. 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_auto_name to use 'project' 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. See also http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html Change-Id: I5598eebe898555869cd65a74950fdbd76a7baa46
Diffstat (limited to 'doc')
-rw-r--r--doc/requirements.txt6
-rw-r--r--doc/source/conf.py22
2 files changed, 6 insertions, 22 deletions
diff --git a/doc/requirements.txt b/doc/requirements.txt
index 6889f20..13389d3 100644
--- a/doc/requirements.txt
+++ b/doc/requirements.txt
@@ -1,4 +1,4 @@
-openstackdocstheme>=1.18.1 # Apache-2.0
-reno>=2.5.0 # Apache-2.0
-sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD
+openstackdocstheme>=2.2.1 # Apache-2.0
+reno>=3.1.0 # Apache-2.0
+sphinx>=2.0.0,!=2.1.0 # BSD
sphinxcontrib-httpdomain>=1.3.0 # BSD
diff --git a/doc/source/conf.py b/doc/source/conf.py
index e519154..070fc08 100644
--- a/doc/source/conf.py
+++ b/doc/source/conf.py
@@ -51,18 +51,8 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
-project = 'python-heatclient'
copyright = 'OpenStack Contributors'
-# 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.
-version = '2.13'
-# The full version, including alpha/beta/rc tags.
-release = '2.13.0'
-
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@@ -93,7 +83,7 @@ exclude_patterns = ['**/#*', '**~', '**/#*#']
# show_authors = False
# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = 'native'
# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []
@@ -140,11 +130,6 @@ html_theme_options = {
# so a file named "default.css" will overwrite the builtin "default.css".
# html_static_path = ['_static']
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-html_last_updated_fmt = '%Y-%m-%d %H:%M'
-
-
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
@@ -261,6 +246,5 @@ texinfo_documents = [
# texinfo_show_urls = 'footnote'
# -- Options for openstackdocstheme -------------------------------------------
-repository_name = 'openstack/python-heatclient'
-bug_project = '997'
-bug_tag = 'docs'
+openstackdocs_repo_name = 'openstack/python-heatclient'
+openstackdocs_use_storyboard = True