From 7cead0c583e4d09301f7ec01ab8f95e5042c66cb Mon Sep 17 00:00:00 2001 From: pengyuesheng Date: Tue, 16 Jul 2019 17:01:19 +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: Ic2c01fbc8fbe768a3d35d4a091576943f42ca64e --- doc/requirements.txt | 2 +- doc/source/conf.py | 8 +++----- releasenotes/source/conf.py | 26 -------------------------- 3 files changed, 4 insertions(+), 32 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 3d272cf..6db47db 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -4,5 +4,5 @@ sphinx>=1.6.2,!=1.6.6,!=1.6.7,<2.0.0;python_version=='2.7' # BSD sphinx>=1.6.2,!=1.6.6,!=1.6.7,!=2.1.0;python_version>='3.4' # BSD -openstackdocstheme>=1.18.1 # Apache-2.0 +openstackdocstheme>=1.20.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 5aa3288..acf6150 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -37,7 +37,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'python-octaviaclient' copyright = u'2016, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. @@ -65,15 +64,15 @@ html_theme_options = { } # Output file base name for HTML help builder. -htmlhelp_basename = '%sdoc' % project +htmlhelp_basename = 'python-octaviaclientdoc' # 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, + 'python-octaviaclient.tex', + u'python-octaviaclient Documentation', u'OpenStack Foundation', 'manual'), ] @@ -84,6 +83,5 @@ latex_documents = [ repository_name = 'openstack/python-octaviaclient' bug_project = '911' bug_tag = 'doc' -html_last_updated_fmt = '%Y-%m-%d %H:%M' autoprogram_cliff_application = 'openstack' diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index af9b4c2..e0c033f 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -60,19 +60,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'octaviaclient Release Notes' copyright = u'2016, OpenStack Foundation' -# 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. -# 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 @@ -152,10 +141,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 @@ -199,17 +184,6 @@ htmlhelp_basename = 'PythonOctaviaClientReleaseNotesdoc' # -- 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, # documentclass [howto, manual, or own class]).