From 07b736f4072777136e0f8ad804b29d9705707bcd Mon Sep 17 00:00:00 2001 From: pengyuesheng Date: Fri, 26 Jul 2019 15:50: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: Iac130cf465b44a730193547bab4da626cce59e5c --- doc/source/conf.py | 36 ++---------------------------------- releasenotes/source/conf.py | 20 ++------------------ sync/doc/requirements.txt | 2 +- 3 files changed, 5 insertions(+), 53 deletions(-) diff --git a/doc/source/conf.py b/doc/source/conf.py index ee755870..96f0081b 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -22,8 +22,6 @@ # All configuration values have a default; values that are commented out # serve to show the default. -import pbr.version - # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. @@ -61,7 +59,6 @@ author = 'OpenStack-Ansible Contributors' category = 'Miscellaneous' copyright = '2014-2016, OpenStack-Ansible Contributors' description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.' -project = 'OpenStack-Ansible' role_name = 'tests' target_name = 'openstack-ansible-' + role_name title = 'OpenStack-Ansible Documentation: ' + role_name + 'role' @@ -71,20 +68,9 @@ oslosphinx_cgit_link = ( "https://opendev.org/openstack/{}".format(target_name) ) -# 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. -version_info = pbr.version.VersionInfo(target_name) -# The full version, including alpha/beta/rc tags. -release = version_info.version_string_with_vcs() -# The short X.Y version. -version = version_info.canonical_version_string() - # openstackdocstheme options repository_name = 'openstack/' + target_name -bug_project = project.lower() +bug_project = 'openstack-ansible' bug_tag = '' # The language for content autogenerated by Sphinx. Refer to documentation @@ -172,10 +158,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 @@ -232,20 +214,6 @@ htmlhelp_basename = target_name + '-docs' # -- 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]). @@ -295,7 +263,7 @@ man_pages = [ # dir menu entry, description, category) texinfo_documents = [ (master_doc, target_name, - title, author, project, + title, author, "OpenStack-Ansible", description, category), ] diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 8237135f..b0605c5a 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -57,7 +57,6 @@ author = 'OpenStack-Ansible Contributors' category = 'Miscellaneous' copyright = '2014-2016, OpenStack-Ansible Contributors' description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.' -project = 'OpenStack-Ansible' role_name = 'tests' target_name = 'openstack-ansible-' + role_name title = 'OpenStack-Ansible Documentation: Central testing repository' @@ -76,7 +75,7 @@ version = '' # openstackdocstheme options repository_name = 'openstack/' + target_name -bug_project = project.lower() +bug_project = 'openstack-ansible' bug_tag = '' # The language for content autogenerated by Sphinx. Refer to documentation @@ -158,10 +157,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 @@ -205,17 +200,6 @@ htmlhelp_basename = target_name + '-docs' # -- 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]). @@ -265,7 +249,7 @@ man_pages = [ # dir menu entry, description, category) texinfo_documents = [ (master_doc, target_name, - title, author, project, + title, author, 'OpenStack-Ansible', description, category), ] diff --git a/sync/doc/requirements.txt b/sync/doc/requirements.txt index 12390ff1..a4fd1738 100644 --- a/sync/doc/requirements.txt +++ b/sync/doc/requirements.txt @@ -11,6 +11,6 @@ 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 reno>=2.5.0 # Apache-2.0 doc8>=0.6.0 # Apache-2.0