From e8b30512549aff2c175fa70612f47b1893e83b06 Mon Sep 17 00:00:00 2001 From: pengyuesheng Date: Tue, 16 Jul 2019 16:01:59 +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: I7407d8dd6261c18db9dd0f7ea8b5963738cfd7da --- api-ref/source/conf.py | 17 ----------------- doc/requirements.txt | 2 +- doc/source/conf.py | 8 +++----- releasenotes/source/conf.py | 23 ----------------------- 4 files changed, 4 insertions(+), 46 deletions(-) diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index efcd8192..f7166fad 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -22,9 +22,6 @@ # All configuration values have a default; values that are commented out # serve to show the default. -from cyborg.version import version_info - - extensions = [ 'openstackdocstheme', 'os_api_ref', @@ -42,7 +39,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Acceleration API Reference' copyright = u'2016-present, OpenStack Foundation' # openstackdocstheme options @@ -50,15 +46,6 @@ repository_name = 'openstack/cyborg' bug_project = 'cyborg' bug_tag = 'api-ref' -# 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 full version, including alpha/beta/rc tags. -release = version_info.release_string() -# The short X.Y version. -version = version_info.version_string() - # The name of the Pygments (syntax highlighting) style to use. pygments_style = 'sphinx' @@ -75,10 +62,6 @@ html_theme_options = { "sidebar_mode": "toc", } -# 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' - # -- Options for LaTeX output ------------------------------------------------- # Grouping the document tree into LaTeX files. List of tuples diff --git a/doc/requirements.txt b/doc/requirements.txt index 6a7ab091..5876deb9 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -9,4 +9,4 @@ sphinxcontrib-pecanwsme>=0.2 # Apache-2.0 sphinxcontrib-seqdiag>=0.8.4 # BSD reno>=2.5.0 # Apache-2.0 os-api-ref>=1.4.0 # Apache-2.0 -openstackdocstheme>=1.19.0 # Apache-2.0 +openstackdocstheme>=1.20.0 # Apache-2.0 diff --git a/doc/source/conf.py b/doc/source/conf.py index 03bacab5..3883e51e 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -41,14 +41,12 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'cyborg' copyright = u'2013, OpenStack Foundation' # openstackdocstheme options repository_name = 'openstack/cyborg' bug_project = 'cyborg' bug_tag = '' -html_last_updated_fmt = '%Y-%m-%d %H:%M' config_generator_config_file = '../../tools/config/cyborg-config-generator.conf' sample_config_basename = '_static/cyborg' @@ -80,7 +78,7 @@ pygments_style = 'sphinx' html_static_path = ['_static'] # Output file base name for HTML help builder. -htmlhelp_basename = '%sdoc' % project +htmlhelp_basename = 'cyborgdoc' # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -92,8 +90,8 @@ html_theme = 'openstackdocs' # [howto/manual]). latex_documents = [ ('index', - '%s.tex' % project, - u'%s Documentation' % project, + 'cyborg.tex', + u'cyborg Documentation', u'OpenStack Foundation', 'manual'), ] diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 9c78bf0f..c76ec429 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -29,7 +29,6 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'Cyborg Release Notes' copyright = u'2018, Cyborg developers' author = u'cyborg developers' @@ -79,10 +78,6 @@ html_theme = 'openstackdocs' # so a file named "default.css" will overwrite the builtin "default.css". # html_static_path = ['_static'] -# 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' - # Custom sidebar templates, must be a dictionary that maps document names # to template names. # @@ -99,24 +94,6 @@ htmlhelp_basename = 'CyborgReleaseNotesdoc' # -- 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]).