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. Depend-On:https://review.opendev.org/#/c/672904/ Change-Id: If54b8222c205262dde5a18c1b562df20d5e4ed6d
This commit is contained in:
parent
36adc844da
commit
764199666c
@ -22,8 +22,6 @@
|
|||||||
# All configuration values have a default; values that are commented out
|
# All configuration values have a default; values that are commented out
|
||||||
# serve to show the default.
|
# serve to show the default.
|
||||||
|
|
||||||
import pbr.version
|
|
||||||
|
|
||||||
# If extensions (or modules to document with autodoc) are in another directory,
|
# If extensions (or modules to document with autodoc) are in another directory,
|
||||||
# add these directories to sys.path here. If the directory is relative to the
|
# add these directories to sys.path here. If the directory is relative to the
|
||||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||||
@ -61,7 +59,6 @@ author = 'OpenStack-Ansible Contributors'
|
|||||||
category = 'Miscellaneous'
|
category = 'Miscellaneous'
|
||||||
copyright = '2014-2016, OpenStack-Ansible Contributors'
|
copyright = '2014-2016, OpenStack-Ansible Contributors'
|
||||||
description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.'
|
description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.'
|
||||||
project = 'OpenStack-Ansible'
|
|
||||||
role_name = 'os_neutron'
|
role_name = 'os_neutron'
|
||||||
target_name = 'openstack-ansible-' + role_name
|
target_name = 'openstack-ansible-' + role_name
|
||||||
title = 'OpenStack-Ansible Documentation: ' + role_name + 'role'
|
title = 'OpenStack-Ansible Documentation: ' + role_name + 'role'
|
||||||
@ -71,20 +68,9 @@ oslosphinx_cgit_link = (
|
|||||||
'https://git.openstack.org/cgit/openstack/{}'.format(target_name)
|
'https://git.openstack.org/cgit/openstack/{}'.format(target_name)
|
||||||
)
|
)
|
||||||
|
|
||||||
# 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_info = pbr.version.VersionInfo(target_name)
|
|
||||||
# The full version, including alpha/beta/rc tags.
|
|
||||||
release = version_info.version_string_with_vcs()
|
|
||||||
# The short X.Y version.
|
|
||||||
version = version_info.canonical_version_string()
|
|
||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
repository_name = 'openstack/' + target_name
|
repository_name = 'openstack/' + target_name
|
||||||
bug_project = project.lower()
|
bug_project = "openstack-ansible"
|
||||||
bug_tag = ''
|
bug_tag = ''
|
||||||
|
|
||||||
# for a list of supported languages.
|
# for a list of supported languages.
|
||||||
@ -171,10 +157,6 @@ html_static_path = ['_static']
|
|||||||
# directly to the root of the documentation.
|
# directly to the root of the documentation.
|
||||||
# html_extra_path = []
|
# 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 = '%Y-%m-%d %H:%M'
|
|
||||||
|
|
||||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||||
# typographically correct entities.
|
# typographically correct entities.
|
||||||
# html_use_smartypants = True
|
# html_use_smartypants = True
|
||||||
@ -231,20 +213,6 @@ htmlhelp_basename = target_name + '-docs'
|
|||||||
|
|
||||||
# -- Options for LaTeX output ---------------------------------------------
|
# -- 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
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
# (source start file, target name, title,
|
# (source start file, target name, title,
|
||||||
# author, documentclass [howto, manual, or own class]).
|
# author, documentclass [howto, manual, or own class]).
|
||||||
@ -294,7 +262,7 @@ man_pages = [
|
|||||||
# dir menu entry, description, category)
|
# dir menu entry, description, category)
|
||||||
texinfo_documents = [
|
texinfo_documents = [
|
||||||
(master_doc, target_name,
|
(master_doc, target_name,
|
||||||
title, author, project,
|
title, author, "OpenStack-Ansible",
|
||||||
description, category),
|
description, category),
|
||||||
]
|
]
|
||||||
|
|
||||||
|
@ -57,7 +57,6 @@ author = 'OpenStack-Ansible Contributors'
|
|||||||
category = 'Miscellaneous'
|
category = 'Miscellaneous'
|
||||||
copyright = '2014-2016, OpenStack-Ansible Contributors'
|
copyright = '2014-2016, OpenStack-Ansible Contributors'
|
||||||
description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.'
|
description = 'OpenStack-Ansible deploys OpenStack environments using Ansible.'
|
||||||
project = 'OpenStack-Ansible'
|
|
||||||
role_name = 'os_neutron'
|
role_name = 'os_neutron'
|
||||||
target_name = 'openstack-ansible-' + role_name
|
target_name = 'openstack-ansible-' + role_name
|
||||||
title = 'OpenStack-Ansible Release Notes: ' + role_name + 'role'
|
title = 'OpenStack-Ansible Release Notes: ' + role_name + 'role'
|
||||||
@ -76,7 +75,7 @@ version = ''
|
|||||||
|
|
||||||
# openstackdocstheme options
|
# openstackdocstheme options
|
||||||
repository_name = 'openstack/' + target_name
|
repository_name = 'openstack/' + target_name
|
||||||
bug_project = project.lower()
|
bug_project = "openstack-ansible"
|
||||||
bug_tag = ''
|
bug_tag = ''
|
||||||
|
|
||||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||||
@ -158,10 +157,6 @@ html_static_path = ['_static']
|
|||||||
# directly to the root of the documentation.
|
# directly to the root of the documentation.
|
||||||
# html_extra_path = []
|
# 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 = '%Y-%m-%d %H:%M'
|
|
||||||
|
|
||||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||||
# typographically correct entities.
|
# typographically correct entities.
|
||||||
# html_use_smartypants = True
|
# html_use_smartypants = True
|
||||||
@ -205,17 +200,6 @@ htmlhelp_basename = target_name + '-docs'
|
|||||||
|
|
||||||
# -- Options for LaTeX output ---------------------------------------------
|
# -- 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
|
# Grouping the document tree into LaTeX files. List of tuples
|
||||||
# (source start file, target name, title,
|
# (source start file, target name, title,
|
||||||
# author, documentclass [howto, manual, or own class]).
|
# author, documentclass [howto, manual, or own class]).
|
||||||
@ -265,7 +249,7 @@ man_pages = [
|
|||||||
# dir menu entry, description, category)
|
# dir menu entry, description, category)
|
||||||
texinfo_documents = [
|
texinfo_documents = [
|
||||||
(master_doc, target_name,
|
(master_doc, target_name,
|
||||||
title, author, project,
|
title, author, "OpenStack-Ansible",
|
||||||
description, category),
|
description, category),
|
||||||
]
|
]
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user