From 9f0f1b947223456fcd90cf053bd1329e2183e775 Mon Sep 17 00:00:00 2001 From: pengyuesheng Date: Fri, 28 Jun 2019 11:03:07 +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. This will show other versions of the doc, too. Change-Id: Id73bbf0a844dee39f9c72df72b1bdb49fa094806 --- api-ref/source/conf.py | 12 ------------ doc/requirements.txt | 2 +- doc/source/conf.py | 14 +------------- lower-constraints.txt | 2 +- releasenotes/source/conf.py | 13 ------------- 5 files changed, 3 insertions(+), 40 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index d7580249d8..ab723b063d 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -36,7 +36,6 @@ extensions = [ repository_name = 'openstack/sahara' bug_project = '935' bug_tag = 'api-ref' -html_last_updated_fmt = '%Y-%m-%d %H:%M' html_theme = 'openstackdocs' html_theme_options = { @@ -67,19 +66,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Data Processing API Reference' copyright = u'2010-present, 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. -# -from sahara.version import version_info -# The full version, including alpha/beta/rc tags. -release = version_info.release_string() -# The short X.Y version. -version = version_info.version_string() - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. # diff --git a/doc/requirements.txt b/doc/requirements.txt index 3274c2572f..1a4b967749 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,7 +1,7 @@ # The order of packages is significant, because pip processes them in the order # of appearance. Changing the order has an impact on the overall integration # process, which may cause wedges in the gate later. -openstackdocstheme>=1.18.1 # Apache-2.0 +openstackdocstheme>=1.20.0 # Apache-2.0 os-api-ref>=1.6.0 # Apache-2.0 reno>=2.5.0 # Apache-2.0 sphinx!=1.6.6,!=1.6.7,>=1.6.2,<2.0.0;python_version=='2.7' # BSD diff --git a/doc/source/conf.py b/doc/source/conf.py index 5d6f426843..2c0396fd5f 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -43,7 +43,6 @@ extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sp repository_name = 'openstack/sahara' bug_project = '935' bug_tag = 'doc' -html_last_updated_fmt = '%Y-%m-%d %H:%M' config_generator_config_file = 'config-generator.conf' config_sample_basename = 'sahara' @@ -86,19 +85,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Sahara' copyright = u'2014, 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. -# -# Version info -from sahara.version import version_info as s_version -release = s_version.release_string() -# The short X.Y version. -version = s_version.version_string() - # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. #language = None @@ -148,7 +136,7 @@ html_theme = 'openstackdocs' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the # documentation. -#html_theme_options = {} +html_theme_options = {"show_other_versions": "True",} # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] diff --git a/lower-constraints.txt b/lower-constraints.txt index 27667bac16..d9a6d70192 100644 --- a/lower-constraints.txt +++ b/lower-constraints.txt @@ -65,7 +65,7 @@ msgpack==0.5.6 munch==2.2.0 netaddr==0.7.19 netifaces==0.10.6 -openstackdocstheme==1.18.1 +openstackdocstheme==1.20.0 openstacksdk==0.12.0 os-api-ref==1.6.0 os-client-config==1.29.0 diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index d7b6574e08..6189e047f9 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -23,7 +23,6 @@ extensions = [ repository_name = 'openstack/sahara' bug_project = '935' bug_tag = 'releasenotes' -html_last_updated_fmt = '%Y-%m-%d %H:%M' # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -35,16 +34,8 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Sahara Release Notes' copyright = u'2015, Sahara Developers' -# Release do not need a version number in the title, they -# cover multiple versions. -# The full version, including alpha/beta/rc tags. -release = '' -# The short X.Y version. -version = '' - # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. exclude_patterns = [] @@ -93,10 +84,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' - # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. # html_use_smartypants = True