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 shows the version selector of the doc, too.

Change-Id: I38f0385a1fd676a4ba18259af7ad384af31ebe5a
This commit is contained in:
pengyuesheng 2019-06-28 10:56:14 +08:00
parent e17325dd3b
commit b529f00937
4 changed files with 3 additions and 46 deletions

View File

@ -5,7 +5,7 @@
# changes how packages are installed. New dependencies should be
# added in alphabetical order, however, some dependencies may need to
# be installed in a specific order.
openstackdocstheme>=1.18.1 # Apache-2.0
openstackdocstheme>=1.20.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
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD

View File

@ -30,8 +30,6 @@ import sys
import django
import horizon.version
# NOTE(amotoki): Sphinx 1.6.x catches warnings from imported modules.
# Ignore warnings from openstack_dashboard.settings in the doc build.
# This can be dropped once Sphinx correctly ignore such warnings.
@ -77,7 +75,6 @@ extensions = [
repository_name = 'openstack/horizon'
bug_project = 'horizon'
bug_tag = 'documentation'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Set aliases for extlinks
# - generic launchpad bug - [:bug:`12345`]
@ -110,18 +107,8 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'Horizon'
copyright = u'2012, 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.
#
# The short X.Y version.
version = horizon.version.version_info.version_string()
# The full version, including alpha/beta/rc tags.
release = horizon.version.version_info.release_string()
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
@ -172,7 +159,7 @@ html_theme = 'openstackdocs'
# further. For a list of options available for each theme, see the
# documentation.
html_theme_options = {
"nosidebar": "false"
"show_other_versions": "True"
}
# Add any paths that contain custom themes here, relative to this directory.
@ -245,17 +232,6 @@ htmlhelp_basename = 'Horizondoc'
# -- 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]).

View File

@ -56,7 +56,7 @@ munch==2.1.0
netaddr==0.7.18
netifaces==0.10.4
nodeenv==0.9.4
openstackdocstheme==1.18.1
openstackdocstheme==1.20.0
openstacksdk==0.11.2
os-client-config==1.28.0
os-service-types==1.2.0

View File

@ -47,7 +47,6 @@ extensions = [
repository_name = 'openstack/horizon'
bug_project = 'horizon'
bug_tag = 'documentation'
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# Set aliases for extlinks
# - generic launchpad bug - [:bug:`12345`]
@ -76,15 +75,8 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'Horizon Release Notes'
copyright = u'2015, Horizon Developers'
# Release notes are version independent
# 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.
# language = None
@ -211,17 +203,6 @@ htmlhelp_basename = 'HorizonReleaseNotesdoc'
# -- 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]).