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: I8c9dbce32c592a99671716c249b1a338824169c0
This commit is contained in:
pengyuesheng 2019-07-04 15:43:29 +08:00
parent 257bfb0a35
commit 090fa214f8
4 changed files with 2 additions and 46 deletions

View File

@ -28,7 +28,6 @@
# serve to show the default.
import os
import subprocess
import sys
# If extensions (or modules to document with autodoc) are in another directory,
@ -61,20 +60,8 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'Dashboard'
copyright = u'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.
from muranodashboard.version import version_info as muranodashboard_version
# The full version, including alpha/beta/rc tags.
release = muranodashboard_version.version_string_with_vcs()
# The short X.Y version.
version = muranodashboard_version.canonical_version_string()
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None
@ -132,9 +119,6 @@ repository_name = 'openstack/murano-dashboard'
bug_project = 'murano'
bug_tag = ''
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# 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.
@ -164,13 +148,6 @@ html_last_updated_fmt = '%Y-%m-%d %H:%M'
# 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 = '%b %d, %Y'
git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
"-n1"]
html_last_updated_fmt = subprocess.check_output(git_cmd).decode('utf-8')
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

View File

@ -52,7 +52,7 @@ murano-pkg-check==0.3.0
netaddr==0.7.19
netifaces==0.10.6
nodeenv==0.9.4
openstackdocstheme==1.18.1
openstackdocstheme==1.20.0
openstacksdk==0.17.0
os-client-config==1.29.0
os-service-types==1.2.0

View File

@ -55,15 +55,8 @@ source_suffix = '.rst'
master_doc = 'index'
# General information about the project.
project = u'Murano Dashboard Release Notes'
copyright = u'2015, Murano 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
@ -114,9 +107,6 @@ repository_name = 'openstack/murano-dashboard'
bug_project = 'murano'
bug_tag = ''
# Must set this variable to include year, month, day, hours, and minutes.
html_last_updated_fmt = '%Y-%m-%d %H:%M'
# 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.
@ -198,17 +188,6 @@ htmlhelp_basename = 'MuranoDashboardReleaseNotesdoc'
# -- 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]).

View File

@ -10,7 +10,7 @@ selenium>=2.50.1 # Apache-2.0
mock>=2.0.0 # BSD
# Docs Requirements
openstackdocstheme>=1.18.1 # Apache-2.0
openstackdocstheme>=1.20.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,>=1.6.2;python_version>='3.4' # BSD
reno>=2.5.0 # Apache-2.0