From bdff261a9d099983b76f170be2311f97d6279630 Mon Sep 17 00:00:00 2001 From: pengyuesheng Date: Fri, 28 Jun 2019 11:13:41 +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: Ia22281730e0303cb9bcde4de6fd28739e544d27e --- doc/requirements.txt | 5 +++-- doc/source/conf.py | 14 ++++---------- 2 files changed, 7 insertions(+), 12 deletions(-) diff --git a/doc/requirements.txt b/doc/requirements.txt index 827758f0..b46abf3f 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,5 +1,6 @@ # 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. -sphinx!=1.6.6,!=1.6.7,>=1.6.2 # BSD -openstackdocstheme>=1.18.1 # 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 +openstackdocstheme>=1.20.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index c67ccb71..b056e5ce 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-barbicanclient' copyright = u'2014, OpenStack Foundation' # If true, '()' will be appended to :func: etc. cross-reference text. @@ -61,20 +60,15 @@ html_theme_options = {} html_theme = 'openstackdocs' # Output file base name for HTML help builder. -htmlhelp_basename = '%sdoc' % project - -# 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' -html_last_updated_fmt = '%Y-%m-%d %H:%M' +htmlhelp_basename = 'python-barbicanclientdoc' # 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-barbicanclient.tex', + u'python-barbicanclient Documentation', u'OpenStack Foundation', 'manual'), ] @@ -84,4 +78,4 @@ latex_documents = [ # -- Options for openstackdocstheme ------------------------------------------- repository_name = 'openstack/python-barbicanclient' bug_project = 'python-barbicanclient' -bug_tag = '' \ No newline at end of file +bug_tag = ''