From 6b056dac251350add9e09002577899cb26bb914b Mon Sep 17 00:00:00 2001 From: pengyuesheng Date: Tue, 16 Jul 2019 17:07:09 +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: I25030e46ced9b1c77fad543aa9285c053a388f14 --- api-ref/source/conf.py | 15 --------------- doc/requirements.txt | 2 +- doc/source/conf.py | 18 ------------------ releasenotes/source/conf.py | 22 ---------------------- 4 files changed, 1 insertion(+), 56 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index e35586970a..18e755fbc4 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -68,7 +68,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Octavia API Reference' copyright = u'2017-present, OpenStack Foundation' # The version info for the project you're documenting, acts as replacement for @@ -151,12 +150,6 @@ pygments_style = 'sphinx' # 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 = '%b %d, %Y' -# Must set this variable to include year, month, day, hours, and minutes. -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 @@ -216,14 +209,6 @@ latex_documents = [ u'OpenStack Foundation', 'manual'), ] -latex_elements = { - # ... - # Additional stuff for the LaTeX preamble. - 'preamble': latex_custom_template, -} - -latex_engine = 'xelatex' - # The name of an image file (relative to this directory) to place at the top of # the title page. # latex_logo = None diff --git a/doc/requirements.txt b/doc/requirements.txt index b2b382d2c5..3ba2a5f859 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -12,7 +12,7 @@ docutils>=0.11 # OSI-Approved Open Source, Public Domain 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 graphviz!=0.5.0,>=0.4 # MIT License -openstackdocstheme>=1.18.1 # Apache-2.0 +openstackdocstheme>=1.20.0 # Apache-2.0 sadisplay>=0.4.8 # BSD reno>=2.5.0 # Apache-2.0 sphinx-feature-classification>=0.2.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index e05c08e266..76f9abae52 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -84,7 +84,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Octavia' copyright = u'2014, OpenStack Octavia Team' # The language for content autogenerated by Sphinx. Refer to documentation @@ -162,10 +161,6 @@ html_theme_options = {'show_other_versions': True} 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 @@ -217,17 +212,6 @@ latex_custom_template = r""" \usepackage{%s} """ % (openstack_logo, pdf_theme_path) -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_custom_template, -} - # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). @@ -239,8 +223,6 @@ latex_documents = [( 'manual' )] -latex_engine = 'xelatex' - # The name of an image file (relative to this directory) to place at the top of # the title page. # latex_logo = None diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 6df11fbd4e..239aedb478 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -60,17 +60,11 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Octavia Release Notes' copyright = u'2015, Octavia Developers' # Release notes are version independent. # The short X.Y version. -# 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. # language = None @@ -150,11 +144,6 @@ html_static_path = ['_static'] # directly to the root of the documentation. # html_extra_path = [] -# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, -# using the given strftime format. -# html_last_updated_fmt = '%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. # html_use_smartypants = True @@ -198,17 +187,6 @@ htmlhelp_basename = 'OctaviaReleaseNotesdoc' # -- 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]).