From cf60c08ab0cef79044481565788f028de2b72099 Mon Sep 17 00:00:00 2001 From: pengyuesheng Date: Fri, 26 Jul 2019 14:36:05 +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: Ie04d6358b9651dfc98ad4533e68ba3aed5398eb2 --- doc/requirements.txt | 2 +- doc/source/conf.py | 9 +++------ releasenotes/source/conf.py | 23 ----------------------- 3 files changed, 4 insertions(+), 30 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 29e810d..d58d659 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,5 +1,5 @@ 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 -openstackdocstheme>=1.18.1 # Apache-2.0 +openstackdocstheme>=1.20.0 # Apache-2.0 # releasenotes reno>=2.5.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 5d78c76..9698dd1 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -23,7 +23,6 @@ sys.path.insert(0, os.path.abspath('../..')) extensions = [ 'sphinx.ext.autodoc', 'openstackdocstheme', - #'sphinx.ext.intersphinx', ] # autodoc generation is a bit aggressive and a nuisance when doing heavy @@ -37,14 +36,12 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'octavia-lib' copyright = u'2018, OpenStack Developers' # openstackdocstheme options repository_name = 'openstack/octavia-lib' bug_project = 'openstack/octavia-lib' bug_tag = 'docs' -html_last_updated_fmt = '%Y-%m-%d %H:%M' # If true, '()' will be appended to :func: etc. cross-reference text. add_function_parentheses = True @@ -66,15 +63,15 @@ pygments_style = 'sphinx' html_theme = 'openstackdocs' # Output file base name for HTML help builder. -htmlhelp_basename = '%sdoc' % project +htmlhelp_basename = 'octavia-libdoc' # 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-lib.tex', + u'octavia-lib Documentation', u'OpenStack Developers', 'manual'), ] diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 86fc36a..c5ef334 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -52,24 +52,12 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'octavia_lib Release Notes' copyright = u'2017, OpenStack Developers' # openstackdocstheme options repository_name = 'openstack/octavia-lib' bug_project = 'openstack/octavia-lib' bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' - -# 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. @@ -197,17 +185,6 @@ htmlhelp_basename = 'octavia_libReleaseNotesdoc' # -- 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]).