From 250c571c0002e13193e9bf88635eaa4a182178b8 Mon Sep 17 00:00:00 2001 From: pengyuesheng Date: Thu, 4 Jul 2019 16:55:16 +0800 Subject: 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: Ibba92185735ed6b41486678fab6390a3168888e2 --- doc/requirements.txt | 2 +- doc/source/conf.py | 20 ---------------- releasenotes/source/conf.py | 57 --------------------------------------------- 3 files changed, 1 insertion(+), 78 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 263cc86..a01432a 100644 --- a/doc/requirements.txt +++ b/doc/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. # These are needed for docs generation -openstackdocstheme>=1.18.1 # Apache-2.0 +openstackdocstheme>=1.20.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;python_version>='3.4' # BSD reno>=2.5.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index ea0a2d5..44499e2 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -33,9 +33,6 @@ repository_name = 'openstack/oslo.middleware' bug_project = 'oslo.middleware' bug_tag = '' -# Must set this variable to include year, month, day, hours, and minutes. -html_last_updated_fmt = '%Y-%m-%d %H:%M' - # autodoc generation is a bit aggressive and a nuisance when doing heavy # text edit cycles. # execute "export SPHINX_DEBUG=1" in your terminal to disable @@ -47,7 +44,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'oslo.middleware' copyright = u'2014, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. @@ -67,19 +63,3 @@ pygments_style = 'sphinx' # html_theme_path = ["."] html_theme = 'openstackdocs' # html_static_path = ['static'] - -# 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, - u'%s Documentation' % project, - u'OpenStack Foundation', 'manual'), -] - -# Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'http://docs.python.org/': None} diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 7a7599f..7445297 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -56,16 +56,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'oslo.middleware Release Notes' copyright = u'2016, oslo.middleware Developers' -# Release notes do not need a version in the title, they span -# multiple versions. -# 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 @@ -145,10 +137,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 = '%Y-%m-%d %H:%M' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True @@ -186,51 +174,6 @@ html_last_updated_fmt = '%Y-%m-%d %H:%M' # 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.middlewareReleaseNotesDoc' - -# -- 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.middlewareReleaseNotes.tex', - u'oslo.middleware Release Notes Documentation', - u'oslo.middleware 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 --------------------------------------- -- cgit v1.2.1