From 5a10ad8825e4814b568a4e8b0a4b0bf4bae51871 Mon Sep 17 00:00:00 2001 From: pengyuesheng Date: Fri, 26 Jul 2019 11:12:50 +0800 Subject: [PATCH] Bump the openstackdocstheme extension to 1.20 Some options are now automatically configured by the version 1.20: - project - html_last_updated_fmt - latex_engine - latex_elements - version - release. Change-Id: I89c8ac57d3983d4e4bd5ff64640042be633e2e1b --- doc/source/conf.py | 11 +++-------- lower-constraints.txt | 2 +- releasenotes/source/conf.py | 33 --------------------------------- test-requirements.txt | 2 +- 4 files changed, 5 insertions(+), 43 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index 2ae577019..165f31f75 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -26,7 +26,6 @@ sys.path.insert(0, os.path.join(os.path.abspath('.'), '_exts')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', - #'sphinx.ext.intersphinx', 'generate_validations_doc', 'openstackdocstheme' ] @@ -42,7 +41,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'tripleo-validations' copyright = u'2016, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. @@ -61,19 +59,16 @@ add_module_names = True # html_static_path = ['static'] # Output file base name for HTML help builder. -htmlhelp_basename = '%sdoc' % project +htmlhelp_basename = 'tripleo-validationsdoc' html_theme = 'openstackdocs' -# Must set this variable to include year, month, day, hours, and minutes. -html_last_updated_fmt = '%Y-%m-%d %H:%M' - # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). latex_documents = [ ('index', - '%s.tex' % project, - u'%s Documentation' % project, + 'tripleo-validations.tex', + u'tripleo-validations Documentation', u'OpenStack Foundation', 'manual'), ] diff --git a/lower-constraints.txt b/lower-constraints.txt index 02016beac..f6ce3bfbc 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -51,7 +51,7 @@ msgpack==0.5.6 munch==2.2.0 netaddr==0.7.18 netifaces==0.10.6 -openstackdocstheme==1.18.1 +openstackdocstheme==1.20.0 openstacksdk==0.12.0 os-client-config==1.29.0 os-net-config==7.1.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index b51f4d1d8..3e718d5d9 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -57,15 +57,6 @@ authors = u'TripleO Developers' project = u'tripleo-validations Release Notes' copyright = u'2017, ' + authors -# 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 = '' -# The full version, including alpha/beta/rc tags. -release = '' - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # @@ -166,12 +157,6 @@ html_static_path = ['_static'] # # html_extra_path = [] -# If not None, a 'Last updated on:' timestamp is inserted at every page -# bottom, using the given strftime format. -# The empty string is equivalent to '%b %d, %Y'. -# -html_last_updated_fmt = '%Y-%m-%d %H:%M' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # @@ -241,24 +226,6 @@ htmlhelp_basename = 'tripleo-validationsReleaseNotesdoc' # -- Options for LaTeX output --------------------------------------------- -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). diff --git a/test-requirements.txt b/test-requirements.txt index 25a16ffcd..6af15dcce 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -2,7 +2,7 @@ # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -openstackdocstheme>=1.18.1 # Apache-2.0 +openstackdocstheme>=1.20.0 # Apache-2.0 hacking<0.12,>=0.11.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0