From 039fdae7d252c234e2cf97529ab20afc78bd51cf Mon Sep 17 00:00:00 2001 From: pengyuesheng Date: Fri, 5 Jul 2019 10:09:55 +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: Iac913e9dea8318ad8398ed7478cb66d845fe7f1e --- doc/requirements.txt | 2 +- doc/source/conf.py | 15 ------------ lower-constraints.txt | 2 +- releasenotes/source/conf.py | 48 ------------------------------------- 4 files changed, 2 insertions(+), 65 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 5f4e8e28..e7bc94ca 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -5,7 +5,7 @@ sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD sphinx!=1.6.6,!=1.6.7,>=1.6.2;python_version>='3.4' # BSD sphinxcontrib-apidoc>=0.2.0 # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 +openstackdocstheme>=1.20.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD doc8>=0.6.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 52ac17b8..37e29057 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -20,7 +20,6 @@ extensions = [ repository_name = 'openstack/oslo.config' bug_project = 'oslo.config' bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' config_generator_config_file = 'config-generator.conf' @@ -38,7 +37,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'oslo.config' copyright = u'2013, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. @@ -64,19 +62,6 @@ modindex_common_prefix = ['oslo_config.'] # html_static_path = ['static'] html_theme = 'openstackdocs' -# Output file base name for HTML help builder. -htmlhelp_basename = '%sdoc' % project - -# 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, - '%s Documentation' % project, - 'OpenStack Foundation', 'manual'), -] - # -- sphinxcontrib.apidoc configuration -------------------------------------- apidoc_module_dir = '../../oslo_config' diff --git a/lower-constraints.txt b/lower-constraints.txt index ccfe33b7..0174b10c 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -23,7 +23,7 @@ mccabe==0.2.1 mock==3.0.0 mox3==0.20.0 netaddr==0.7.18 -openstackdocstheme==1.18.1 +openstackdocstheme==1.20.0 os-client-config==1.28.0 oslo.i18n==3.15.3 oslo.log==3.36.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index bf6cc36a..2ac788fa 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -46,7 +46,6 @@ extensions = [ repository_name = 'openstack/oslo.config' bug_project = 'oslo.config' bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -61,7 +60,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'oslo.config Release Notes' copyright = u'2016, oslo.config Developers' # Release notes do not need a version in the title, they span @@ -191,52 +189,6 @@ html_static_path = ['_static'] # This is the file name suffix for HTML files (e.g. ".xhtml"). # html_file_suffix = None -# Output file base name for HTML help builder. -htmlhelp_basename = 'oslo.configReleaseNotesdoc' - - -# -- 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': '', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - ('index', 'oslo.configReleaseNotes.tex', - u'oslo.config Release Notes Documentation', - u'oslo.config Developers', 'manual'), -] - -# The name of an image file (relative to this directory) to place at the top of -# the title page. -# latex_logo = None - -# For "manual" documents, if this is true, then toplevel headings are parts, -# not chapters. -# latex_use_parts = False - -# If true, show page references after internal links. -# latex_show_pagerefs = False - -# If true, show URL addresses after external links. -# latex_show_urls = False - -# Documents to append as an appendix to all manuals. -# latex_appendices = [] - -# If false, no module index is generated. -# latex_domain_indices = True - # -- Options for manual page output ---------------------------------------