From 28cdf7f6764f13e8523ab1c6297f45760e241d71 Mon Sep 17 00:00:00 2001 From: pengyuesheng Date: Wed, 17 Jul 2019 10:35:11 +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: I7c1f7a9298e6e75389aca6b485bec7b878ba1a20 --- doc/requirements.txt | 3 +-- doc/source/conf.py | 11 +++-------- releasenotes/source/conf.py | 28 ---------------------------- 3 files changed, 4 insertions(+), 38 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index a5b398b8..ca069c3f 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,8 +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. - -openstackdocstheme>=1.18.1 # Apache-2.0 +openstackdocstheme>=1.20.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0 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,!=2.1.0;python_version>='3.4' # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 4a41905b..deb27a8d 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -52,7 +52,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'octavia-dashboard' copyright = u'2017, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. @@ -81,19 +80,15 @@ html_theme_options = { html_static_path = [] # Output file base name for HTML help builder. -htmlhelp_basename = '%sdoc' % project - -# 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' +htmlhelp_basename = 'octavia-dashboarddoc' # 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, + 'octavia-dashboard.tex', + u'octavia-dashboard Documentation', u'OpenStack Foundation', 'manual'), ] diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 633741c8..f35e9d38 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -65,17 +65,9 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Octavia Dashboard Release Notes' copyright = u'2017, Octavia Developers' author = u'Octavia Developers' -# Release notes are version independent. -# -# The full version, including alpha/beta/rc tags. -release = '' -# The short X.Y version. -version = '' - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # @@ -113,8 +105,6 @@ html_theme = 'openstackdocs' # so a file named "default.css" will overwrite the builtin "default.css". html_static_path = ['_static'] -html_last_updated_fmt = '%Y-%m-%d %H:%M' - # If false, no module index is generated. html_domain_indices = False @@ -130,24 +120,6 @@ htmlhelp_basename = 'OctaviaDashboardReleaseNotesdoc' # -- 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]).